##// END OF EJS Templates
Merge pull request #13214 from Kojoley/ipexec-pycharm-qol-fix...
Merge pull request #13214 from Kojoley/ipexec-pycharm-qol-fix ipexec: prevent output coloring under PyCharm

File last commit:

r25999:85c8fd57
r26941:32ffaeff merge
Show More
CONTRIBUTING.md
95 lines | 3.6 KiB | text/x-minidsrc | MarkdownLexer
Matthias Bussonnier
add info to contributing.md
r24598 ## Triaging Issues
BinaryCrochet
Proofread & edited section "Triaging Issues"...
r24748 On the IPython repository, we strive to trust users and give them responsibility.
CarsonGSmith
Update CONTRIBUTING.md
r24795 By using one of our bots, any user can close issues or add/remove
Matthias Bussonnier
add info to contributing.md
r24598 labels by mentioning the bot and asking it to do things on your behalf.
BinaryCrochet
Proofread & edited section "Triaging Issues"...
r24748 To close an issue (or PR), even if you did not create it, use the following:
Matthias Bussonnier
add info to contributing.md
r24598
> @meeseeksdev close
CarsonGSmith
Update CONTRIBUTING.md
r24795 This command can be in the middle of another comment, but must start on its
Matthias Bussonnier
Take into account Carol Suggestions
r24602 own line.
Matthias Bussonnier
add info to contributing.md
r24598
CarsonGSmith
Update CONTRIBUTING.md
r24795 To add labels to an issue, ask the bot to `tag` with a comma-separated list of
Matthias Bussonnier
add info to contributing.md
r24598 tags to add:
> @meeseeksdev tag windows, documentation
BinaryCrochet
Proofread & edited section "Triaging Issues"...
r24748 Only already pre-created tags can be added. So far, the list is limited to:
Matthias Bussonnier
Take into account Carol Suggestions
r24602 `async/await`, `backported`, `help wanted`, `documentation`, `notebook`,
`tab-completion`, `windows`
Matthias Bussonnier
add info to contributing.md
r24598
To remove a label, use the `untag` command:
> @meeseeksdev untag windows, documentation
Shashank Kumar
docs(CONTRIBUTING): Minor fix
r24656 We'll be adding additional capabilities for the bot and will share them here
Matthias Bussonnier
Take into account Carol Suggestions
r24602 when they are ready to be used.
Matthias Bussonnier
add info to contributing.md
r24598
MinRK
add CONTRIBUTING.md...
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.
Mukesh Bhandarkar
Updating Contributing.md with grammer
r24772 3. Try to include a minimal reproducible test case.
MinRK
add CONTRIBUTING.md...
r11489 4. Include relevant system information. Start with the output of:
python -c "import IPython; print(IPython.sys_info())"
Matthias Bussonnier
Take into account Carol Suggestions
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
add CONTRIBUTING.md...
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:
Mukesh Bhandarkar
Updating Contributing.md with grammer
r24772 - bugfixes should include regression tests.
- new behavior should at least get minimal exercise.
Paul Ivanov
mention pr folder in whatsnew and CONTRIBUTING
r12242 * New features and backwards-incompatible changes should be documented by adding
Paul Ivanov
fix links
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
Mention that we don't do cleanup PRs
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
add CONTRIBUTING.md...
r11489
Paul Ivanov
remove test_pr.py...
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
add CONTRIBUTING.md...
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
Fix #11573 add docs for running tests
r24930 ## Running Tests
rushabh-v
fix grammatical error in CONTRIBUTING.md
r25999 All the tests can be run by using
Partha P. Mukherjee
Fix #11573 add docs for running tests
r24930 ```shell
Matthias Bussonnier
be more precise on how to run tests
r24933 iptest
Partha P. Mukherjee
Fix #11573 add docs for running tests
r24930 ```
Matthias Bussonnier
be more precise on how to run tests
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
Fix #11573 add docs for running tests
r24930 ```shell
Matthias Bussonnier
be more precise on how to run tests
r24933 iptest IPython.core.tests.test_alias
Partha P. Mukherjee
Fix #11573 add docs for running tests
r24930 ```
Matthias Bussonnier
be more precise on how to run tests
r24933 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
Fix #11573 add docs for running tests
r24930 ```shell
Matthias Bussonnier
be more precise on how to run tests
r24933 iptest IPython.core.tests.test_alias:test_alias_lifecycle
Partha P. Mukherjee
Fix #11573 add docs for running tests
r24930 ```
Matthias Bussonnier
be more precise on how to run tests
r24933 For convenience, the full path to a file can often be used instead of the module path on unix systems. For example we can run all the tests by using
Partha P. Mukherjee
Fix #11573 add docs for running tests
r24930 ```shell
Luciana da Costa Marques
Fix small typo in CONTRIBUTING.md
r25064 iptest IPython/core/tests/test_alias.py
Partha P. Mukherjee
Fix #11573 add docs for running tests
r24930 ```