CONTRIBUTING.md
118 lines
| 4.7 KiB
| text/x-minidsrc
|
MarkdownLexer
Matthias Bussonnier
|
r24598 | ## Triaging Issues | ||
BinaryCrochet
|
r24748 | On the IPython repository, we strive to trust users and give them responsibility. | ||
CarsonGSmith
|
r24795 | By using one of our bots, any user can close issues or add/remove | ||
Matthias Bussonnier
|
r24598 | labels by mentioning the bot and asking it to do things on your behalf. | ||
BinaryCrochet
|
r24748 | To close an issue (or PR), even if you did not create it, use the following: | ||
Matthias Bussonnier
|
r24598 | |||
> @meeseeksdev close | ||||
CarsonGSmith
|
r24795 | This command can be in the middle of another comment, but must start on its | ||
Matthias Bussonnier
|
r24602 | own line. | ||
Matthias Bussonnier
|
r24598 | |||
CarsonGSmith
|
r24795 | 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 | ||||
BinaryCrochet
|
r24748 | Only already pre-created tags can be added. So far, the list is limited to: | ||
Matthias Bussonnier
|
r24602 | `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 | ||||
Shashank Kumar
|
r24656 | We'll be adding additional capabilities for the bot and will share them here | ||
Matthias Bussonnier
|
r24602 | 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. | ||||
Jarrod Millman
|
r27712 | 2. If possible, try updating to main and reproducing your issue, | ||
MinRK
|
r11489 | because we may have already fixed it. | ||
Mukesh Bhandarkar
|
r24772 | 3. Try to include a minimal reproducible test case. | ||
MinRK
|
r11489 | 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. | ||||
Jarrod Millman
|
r27712 | * Pull Requests should generally be made against main | ||
MinRK
|
r11489 | * Pull Requests should be tested, if feasible: | ||
Mukesh Bhandarkar
|
r24772 | - 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 | |||
krassowski
|
r27923 | [GitHub Actions](https://github.com/ipython/ipython/actions/workflows/test.yml) 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). | ||||
Partha P. Mukherjee
|
r24930 | ## Running Tests | ||
rushabh-v
|
r25999 | All the tests can be run by using | ||
Partha P. Mukherjee
|
r24930 | ```shell | ||
Nikita Kniazev
|
r27042 | pytest | ||
Partha P. Mukherjee
|
r24930 | ``` | ||
Matthias Bussonnier
|
r24933 | All the tests for a single module (for example **test_alias**) can be run by using the fully qualified path to the module. | ||
Partha P. Mukherjee
|
r24930 | ```shell | ||
Nikita Kniazev
|
r27042 | pytest IPython/core/tests/test_alias.py | ||
Partha P. Mukherjee
|
r24930 | ``` | ||
Nikita Kniazev
|
r27042 | Only a single test (for example **test_alias_lifecycle**) within a single file can be run by adding the specific test after a `::` at the end: | ||
Partha P. Mukherjee
|
r24930 | ```shell | ||
Nikita Kniazev
|
r27042 | pytest IPython/core/tests/test_alias.py::test_alias_lifecycle | ||
Partha P. Mukherjee
|
r24930 | ``` | ||
krassowski
|
r27923 | |||
## Code style | ||||
Jason Grout
|
r27941 | * Before committing, run `darker -r 60625f241f298b5039cb2debc365db38aa7bb522 <file path>` to apply selective `black` formatting on modified regions using [darker](https://github.com/akaihola/darker). | ||
krassowski
|
r27923 | * For newly added modules or refactors, please enable static typing analysis with `mypy` for the modified module by adding the file path in [`mypy.yml`](https://github.com/ipython/ipython/blob/main/.github/workflows/mypy.yml) workflow. | ||
Jason Grout
|
r27941 | * As described in the pull requests section, please avoid excessive formatting changes; if a formatting-only commit is necessary, consider adding its hash to [`.git-blame-ignore-revs`](https://github.com/ipython/ipython/blob/main/.git-blame-ignore-revs) file. | ||
krassowski
|
r27923 | |||
## Documentation | ||||
Sphinx documentation can be built locally using standard sphinx `make` commands. To build HTML documentation from the root of the project, execute: | ||||
```shell | ||||
pip install -r docs/requirements.txt # only needed once | ||||
make -C docs/ html SPHINXOPTS="-W" | ||||
``` | ||||
To force update of the API documentation, precede the `make` command with: | ||||
```shell | ||||
python3 docs/autogen_api.py | ||||
``` | ||||
Similarly, to force-update the configuration, run: | ||||
```shell | ||||
python3 docs/autogen_config.py | ||||
``` | ||||