##// END OF EJS Templates
mention pr folder in whatsnew and CONTRIBUTING
Paul Ivanov -
Show More
@@ -1,37 +1,41 b''
1 ## Opening an Issue
1 ## Opening an Issue
2
2
3 When opening a new Issue, please take the following steps:
3 When opening a new Issue, please take the following steps:
4
4
5 1. Search GitHub and/or Google for your issue to avoid duplicate reports.
5 1. Search GitHub and/or Google for your issue to avoid duplicate reports.
6 Keyword searches for your error messages are most helpful.
6 Keyword searches for your error messages are most helpful.
7 2. If possible, try updating to master and reproducing your issue,
7 2. If possible, try updating to master and reproducing your issue,
8 because we may have already fixed it.
8 because we may have already fixed it.
9 3. Try to include a minimal reproducible test case
9 3. Try to include a minimal reproducible test case
10 4. Include relevant system information. Start with the output of:
10 4. Include relevant system information. Start with the output of:
11
11
12 python -c "import IPython; print(IPython.sys_info())"
12 python -c "import IPython; print(IPython.sys_info())"
13
13
14 And include any relevant package versions, depending on the issue,
14 And include any relevant package versions, depending on the issue,
15 such as matplotlib, numpy, Qt, Qt bindings (PyQt/PySide), tornado, web browser, etc.
15 such as matplotlib, numpy, Qt, Qt bindings (PyQt/PySide), tornado, web browser, etc.
16
16
17 ## Pull Requests
17 ## Pull Requests
18
18
19 Some guidelines on contributing to IPython:
19 Some guidelines on contributing to IPython:
20
20
21 * All work is submitted via Pull Requests.
21 * All work is submitted via Pull Requests.
22 * Pull Requests can be submitted as soon as there is code worth discussing.
22 * Pull Requests can be submitted as soon as there is code worth discussing.
23 Pull Requests track the branch, so you can continue to work after the PR is submitted.
23 Pull Requests track the branch, so you can continue to work after the PR is submitted.
24 Review and discussion can begin well before the work is complete,
24 Review and discussion can begin well before the work is complete,
25 and the more discussion the better.
25 and the more discussion the better.
26 The worst case is that the PR is closed.
26 The worst case is that the PR is closed.
27 * Pull Requests should generally be made against master
27 * Pull Requests should generally be made against master
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 [development](docs/source/whatsnew/development) directory,
33 see [the README.md there](docs/source/whatsnew/development/README.md) for
34 details.
31
35
32 [Travis](http://travis-ci.org/#!/ipython/ipython) does a pretty good job testing IPython and Pull Requests,
36 [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),
37 but it may make sense to manually perform tests (possibly with our `test_pr` script),
34 particularly for PRs that affect `IPython.parallel` or Windows.
38 particularly for PRs that affect `IPython.parallel` or Windows.
35
39
36 For more detailed information, see our [GitHub Workflow](https://github.com/ipython/ipython/wiki/Dev:-GitHub-workflow).
40 For more detailed information, see our [GitHub Workflow](https://github.com/ipython/ipython/wiki/Dev:-GitHub-workflow).
37
41
@@ -1,15 +1,22 b''
1 =====================
1 =====================
2 Development version
2 Development version
3 =====================
3 =====================
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
10
17
11 Backwards incompatible changes
18 Backwards incompatible changes
12 ------------------------------
19 ------------------------------
13
20
14 * Python 2.6 and 3.2 are no longer supported: the minimum required
21 * Python 2.6 and 3.2 are no longer supported: the minimum required
15 Python versions are now 2.7 and 3.3.
22 Python versions are now 2.7 and 3.3.
General Comments 0
You need to be logged in to leave comments. Login now