CONTRIBUTING.md
74 lines
| 3.0 KiB
| text/x-minidsrc
|
MarkdownLexer
Matthias Bussonnier
|
r24598 | ## Triaging Issues | ||
Matthias Bussonnier
|
r24602 | On the IPython repository we strive to trust users and give them responsibility. | ||
By using one of our bot, any user can close issues, add and remove | ||||
Matthias Bussonnier
|
r24598 | labels by mentioning the bot and asking it to do things on your behalf. | ||
Matthias Bussonnier
|
r24602 | To close and issue (or PR), even if you did not create it, use the following: | ||
Matthias Bussonnier
|
r24598 | |||
> @meeseeksdev close | ||||
Matthias Bussonnier
|
r24602 | This command can be in the middle of another comments, but must start on its | ||
own line. | ||||
Matthias Bussonnier
|
r24598 | |||
Matthias Bussonnier
|
r24602 | To add labels to an issue, ask the bot to `tag` with a comma separated list of | ||
Matthias Bussonnier
|
r24598 | tags to add: | ||
> @meeseeksdev tag windows, documentation | ||||
Matthias Bussonnier
|
r24602 | Only already pre-created tags can be added, and the list is so far limited to | ||
`async/await`, `backported`, `help wanted`, `documentation`, `notebook`, | ||||
`tab-completion`, `windows` | ||||
Matthias Bussonnier
|
r24598 | |||
To remove a label, use the `untag` command: | ||||
> @meeseeksdev untag windows, documentation | ||||
Matthias Bussonnier
|
r24602 | e'll be adding additional capabilities for the bot and will share them here | ||
when they are ready to be used. | ||||
Matthias Bussonnier
|
r24598 | |||
MinRK
|
r11489 | ## Opening an Issue | ||
When opening a new Issue, please take the following steps: | ||||
1. Search GitHub and/or Google for your issue to avoid duplicate reports. | ||||
Keyword searches for your error messages are most helpful. | ||||
2. If possible, try updating to master and reproducing your issue, | ||||
because we may have already fixed it. | ||||
3. Try to include a minimal reproducible test case | ||||
4. Include relevant system information. Start with the output of: | ||||
python -c "import IPython; print(IPython.sys_info())" | ||||
Matthias Bussonnier
|
r24602 | And include any relevant package versions, depending on the issue, such as | ||
matplotlib, numpy, Qt, Qt bindings (PyQt/PySide), tornado, web browser, etc. | ||||
MinRK
|
r11489 | |||
## Pull Requests | ||||
Some guidelines on contributing to IPython: | ||||
* All work is submitted via Pull Requests. | ||||
* Pull Requests can be submitted as soon as there is code worth discussing. | ||||
Pull Requests track the branch, so you can continue to work after the PR is submitted. | ||||
Review and discussion can begin well before the work is complete, | ||||
and the more discussion the better. | ||||
The worst case is that the PR is closed. | ||||
* Pull Requests should generally be made against master | ||||
* Pull Requests should be tested, if feasible: | ||||
- bugfixes should include regression tests | ||||
- new behavior should at least get minimal exercise | ||||
Paul Ivanov
|
r12242 | * New features and backwards-incompatible changes should be documented by adding | ||
Paul Ivanov
|
r12244 | a new file to the [pr](docs/source/whatsnew/pr) directory, see [the README.md | ||
there](docs/source/whatsnew/pr/README.md) for details. | ||||
Thomas Kluyver
|
r20636 | * Don't make 'cleanup' pull requests just to change code style. | ||
We don't follow any style guide strictly, and we consider formatting changes | ||||
unnecessary noise. | ||||
If you're making functional changes, you can clean up the specific pieces of | ||||
code you're working on. | ||||
MinRK
|
r11489 | |||
Paul Ivanov
|
r22996 | [Travis](http://travis-ci.org/#!/ipython/ipython) does a pretty good job testing | ||
IPython and Pull Requests, but it may make sense to manually perform tests, | ||||
MinRK
|
r11489 | particularly for PRs that affect `IPython.parallel` or Windows. | ||
For more detailed information, see our [GitHub Workflow](https://github.com/ipython/ipython/wiki/Dev:-GitHub-workflow). | ||||