@@ -42,6 +42,7 @@ The official tag is `python-attrs` and helping out in support frees us up to imp
42
42
You can (and should) run our test suite using [ * tox* ] .
43
43
However, you’ll probably want a more traditional environment as well.
44
44
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.
45
46
46
47
First [ fork] ( https://github.com/python-attrs/attrs/fork ) the repository on GitHub.
47
48
@@ -63,7 +64,7 @@ Then add the *attrs* repository as *upstream* remote:
63
64
$ git remote add -t main -m main --tags upstream https://github.com/python-attrs/attrs.git
64
65
```
65
66
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 :
67
68
68
69
``` console
69
70
$ git fetch upstream
@@ -98,10 +99,10 @@ $ make html
98
99
99
100
The built documentation can then be found in ` docs/_build/html/ ` .
100
101
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 :
102
103
103
104
``` console
104
- $ git fetch --all
105
+ $ git fetch upstream
105
106
$ git checkout -b my_topical_branch upstream/main
106
107
```
107
108
@@ -113,12 +114,17 @@ $ git push -u origin
113
114
114
115
and publish the PR in GitHub's web interface!
115
116
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 :
117
118
118
119
``` console
119
- $ git fetch --all
120
120
$ 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
122
128
```
123
129
124
130
---
@@ -205,7 +211,7 @@ But it's way more comfortable to run it locally and *git* catching avoidable err
205
211
First line of new section.
206
212
```
207
213
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 ) !
209
215
210
216
211
217
### Changelog
0 commit comments