Show More
@@ -0,0 +1,17 b'' | |||||
|
1 | Documenting What's New | |||
|
2 | ---------------------- | |||
|
3 | ||||
|
4 | When making a new pull request that either adds a new feature, or makes a | |||
|
5 | backwards-incompatible change to IPython, please add a new `.rst` file in this | |||
|
6 | directory documenting this change as a part of your Pull Request. | |||
|
7 | ||||
|
8 | This will allow multiple Pull Requests to do the same without conflicting with | |||
|
9 | one another. Periodically, IPython developers with commit rights will run a | |||
|
10 | script and populate [developement.rst](../developement.rst) with the contents | |||
|
11 | of this directory, and clean it up. | |||
|
12 | ||||
|
13 | Files which describe new features can have any name, such as | |||
|
14 | `antigravity-feature.rst`, whereas backwards incompatible changes should have a | |||
|
15 | filename of `incompat-switching-to-perl.rst`. Our "What's new" files always have | |||
|
16 | two sections, and this prefix scheme will make sure that the backwards | |||
|
17 | incompatible changes get routed to their proper section. |
General Comments 0
You need to be logged in to leave comments.
Login now