Skip to content

Commit e4c9f27

Browse files
chryslehynek
andauthored
CONTRIBUTING: Small improvements (#1123)
* Small improvements to docs * Corrected branch deletion * Apply suggestions from code review Co-authored-by: Hynek Schlawack <[email protected]> * Applied more review feedback --------- Co-authored-by: Hynek Schlawack <[email protected]>
1 parent 683d056 commit e4c9f27

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

.github/CONTRIBUTING.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ The official tag is `python-attrs` and helping out in support frees us up to imp
4242
You can (and should) run our test suite using [*tox*].
4343
However, you’ll probably want a more traditional environment as well.
4444
We highly recommend to develop using the latest Python release because we try to take advantage of modern features whenever possible.
45+
Also, running [*pre-commit*] later on will require the latest Python version.
4546

4647
First [fork](https://github.com/python-attrs/attrs/fork) the repository on GitHub.
4748

@@ -63,7 +64,7 @@ Then add the *attrs* repository as *upstream* remote:
6364
$ git remote add -t main -m main --tags upstream https://github.com/python-attrs/attrs.git
6465
```
6566

66-
The next step is to sync the upstream repository with your local copy:
67+
The next step is to sync your local copy with the upstream repository:
6768

6869
```console
6970
$ git fetch upstream
@@ -98,10 +99,10 @@ $ make html
9899

99100
The built documentation can then be found in `docs/_build/html/`.
100101

101-
To file a pull request, create a new branch on top of the upstream repository:
102+
To file a pull request, create a new branch on top of the upstream repository's `main` branch:
102103

103104
```console
104-
$ git fetch --all
105+
$ git fetch upstream
105106
$ git checkout -b my_topical_branch upstream/main
106107
```
107108

@@ -113,12 +114,17 @@ $ git push -u origin
113114

114115
and publish the PR in GitHub's web interface!
115116

116-
Before starting to work on your next pull request, run the following command to sync your local repository with the remotes:
117+
After your pull request is merged and the branch is no longer needed, delete it:
117118

118119
```console
119-
$ git fetch --all
120120
$ git checkout main
121-
$ git merge
121+
$ git push --delete origin my_topical_branch && git branch -D my_topical_branch
122+
```
123+
124+
Before starting to work on your next pull request, run the following command to sync your local repository with the remote *upstream*:
125+
126+
```console
127+
$ git fetch upstream -u main:main
122128
```
123129

124130
---
@@ -205,7 +211,7 @@ But it's way more comfortable to run it locally and *git* catching avoidable err
205211
First line of new section.
206212
```
207213

208-
- If you add a new feature, demonstrate its awesomeness on the [examples page](https://github.com/python-attrs/attrs/blob/main/docs/examples.rst)!
214+
- If you add a new feature, demonstrate its awesomeness on the [examples page](https://github.com/python-attrs/attrs/blob/main/docs/examples.md)!
209215

210216

211217
### Changelog

0 commit comments

Comments
 (0)