Show More
@@ -0,0 +1,18 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 [development.rst](../development.rst) | |||
|
11 | with the contents 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 **must have** | |||
|
15 | have a filename starting with `incompat-`, such as | |||
|
16 | `incompat-switching-to-perl.rst`. Our "What's new" files always have two | |||
|
17 | sections, and this prefix scheme will make sure that the backwards incompatible | |||
|
18 | changes get routed to their proper section. |
1 | NO CONTENT: new file 100644 |
|
NO CONTENT: new file 100644 |
1 | NO CONTENT: new file 100644 |
|
NO CONTENT: new file 100644 |
@@ -28,6 +28,9 b' Some guidelines on contributing to IPython:' | |||||
28 | * Pull Requests should be tested, if feasible: |
|
28 | * Pull Requests should be tested, if feasible: | |
29 | - bugfixes should include regression tests |
|
29 | - bugfixes should include regression tests | |
30 | - new behavior should at least get minimal exercise |
|
30 | - new behavior should at least get minimal exercise | |
|
31 | * New features and backwards-incompatible changes should be documented by adding | |||
|
32 | a new file to the [pr](docs/source/whatsnew/pr) directory, see [the README.md | |||
|
33 | there](docs/source/whatsnew/pr/README.md) for details. | |||
31 |
|
34 | |||
32 | [Travis](http://travis-ci.org/#!/ipython/ipython) does a pretty good job testing IPython and Pull Requests, |
|
35 | [Travis](http://travis-ci.org/#!/ipython/ipython) does a pretty good job testing IPython and Pull Requests, | |
33 | but it may make sense to manually perform tests (possibly with our `test_pr` script), |
|
36 | but it may make sense to manually perform tests (possibly with our `test_pr` script), |
@@ -4,6 +4,13 b'' | |||||
4 |
|
4 | |||
5 | This document describes in-flight development work. |
|
5 | This document describes in-flight development work. | |
6 |
|
6 | |||
|
7 | .. warning:: | |||
|
8 | ||||
|
9 | Please do not edit this file by hand (doing so will likely cause merge | |||
|
10 | conflicts for other Pull Requests). Instead, create a new file in the | |||
|
11 | `docs/source/whatsnew/pr` folder | |||
|
12 | ||||
|
13 | ||||
7 | - `%%capture` cell magic now captures the rich display output, not just |
|
14 | - `%%capture` cell magic now captures the rich display output, not just | |
8 | stdout/stderr |
|
15 | stdout/stderr | |
9 |
|
16 |
General Comments 0
You need to be logged in to leave comments.
Login now