Skip to content

Commit 95ab085

Browse files
authored
update Contributing.md (#15182)
2 parents f96610c + bdc2997 commit 95ab085

File tree

1 file changed

+14
-34
lines changed

1 file changed

+14
-34
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,3 @@
1-
## Triaging Issues
2-
3-
On the IPython repository, we strive to trust users and give them responsibility.
4-
By using one of our bots, any user can close issues or add/remove
5-
labels by mentioning the bot and asking it to do things on your behalf.
6-
7-
To close an issue (or PR), even if you did not create it, use the following:
8-
9-
> @meeseeksdev close
10-
11-
This command can be in the middle of another comment, but must start on its
12-
own line.
13-
14-
To add labels to an issue, ask the bot to `tag` with a comma-separated list of
15-
tags to add:
16-
17-
> @meeseeksdev tag windows, documentation
18-
19-
Only already pre-created tags can be added. So far, the list is limited to:
20-
`async/await`, `backported`, `help wanted`, `documentation`, `notebook`,
21-
`tab-completion`, `windows`
22-
23-
To remove a label, use the `untag` command:
24-
25-
> @meeseeksdev untag windows, documentation
26-
27-
We'll be adding additional capabilities for the bot and will share them here
28-
when they are ready to be used.
29-
301
## Opening an Issue
312

323
When opening a new Issue, please take the following steps:
@@ -43,6 +14,20 @@ When opening a new Issue, please take the following steps:
4314
And include any relevant package versions, depending on the issue, such as
4415
matplotlib, numpy, Qt, Qt bindings (PyQt/PySide), tornado, web browser, etc.
4516

17+
## Triaging issue and Fixing issue
18+
19+
**Do NOT leave a message asking if you can work on an issue; start by trying to
20+
reproduce it and fix it**
21+
22+
You are looking for an issue to fix and find an issue that can be close or you
23+
suspect is not relevant anymore, please comment on it and say so to avoid future
24+
contributor to lose time doing the same.
25+
26+
If you have technical questions or reproducing question you are allowed to:
27+
28+
- Ask clarification on the issue.
29+
- Open a draft PR even with terrible code and ask for advice.
30+
4631
## Pull Requests
4732

4833
Some guidelines on contributing to IPython:
@@ -90,11 +75,6 @@ Only a single test (for example **test_alias_lifecycle**) within a single file c
9075
pytest IPython/core/tests/test_alias.py::test_alias_lifecycle
9176
```
9277

93-
## Code style
94-
95-
* Before committing, run `darker -r 60625f241f298b5039cb2debc365db38aa7bb522 <file path>` to apply selective `black` formatting on modified regions using [darker](https://github.com/akaihola/darker)==1.5.1 and black==22.10.0
96-
* 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.
97-
9878
## Documentation
9979

10080
Sphinx documentation can be built locally using standard sphinx `make` commands. To build HTML documentation from the root of the project, execute:

0 commit comments

Comments
 (0)