CONTRIBUTING: Added instructions for PR workflow (#1105)

* CONTRIBUTING: Added instructions for PR workflow

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Added changelog entry

* Use inline code for changelog filename

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>

* Add console prompt to command

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>

* Made some more improvements

* Apply suggestions from code review

* Update .github/CONTRIBUTING.md

* Update changelog.d/1105.change.md

* Update .github/CONTRIBUTING.md

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>

* Update .github/CONTRIBUTING.md

* Update .github/CONTRIBUTING.md

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Hynek Schlawack <hs@ox.cx>

Author: 4 people

.github/CONTRIBUTING.md

@@ -43,18 +43,35 @@ You can (and should) run our test suite using [*tox*].
 However, you’ll probably want a more traditional environment as well.
 We highly recommend to develop using the latest Python release because we try to take advantage of modern features whenever possible.
 
-Clone the *attrs* repository to your computer:
+First [fork](https://github.com/python-attrs/attrs/fork) the repository on GitHub.
+
+Clone the fork to your computer:
 
 ```console
-$ git clone git@github.com:python-attrs/attrs.git
+$ git clone git@github.com:<your-username>/attrs.git
 ```
 
 Or if you prefer to use Git via HTTPS:
 
 ```console
-$ git clone https://github.com/python-attrs/attrs.git
+$ git clone https://github.com/<your-username>/attrs.git
+```
+
+Then add the *attrs* repository as *upstream* remote:
+
+```console
+$ git remote add -t main -m main --tags upstream https://github.com/python-attrs/attrs.git
+```
+
+The next step is to sync the upstream repository with your local copy:
+
+```console
+$ git fetch upstream
 ```
 
+This is important to obtain eventually missing tags, which are needed to install the development version later on.
+See [#1104](https://github.com/python-attrs/attrs/issues/1104) for more information.
+
 Change into the newly created directory and after activating a virtual environment install an editable version of *attrs* along with its tests and docs requirements:
 
 ```console
@@ -81,6 +98,29 @@ $ make html
 
 The built documentation can then be found in `docs/_build/html/`.
 
+To file a pull request, create a new branch on top of the upstream repository:
+
+```console
+$ git fetch --all
+$ git checkout -b my_topical_branch upstream/main
+```
+
+Make your changes, push them to your fork (the remote *origin*):
+
+```console
+$ git push -u origin
+```
+
+and publish the PR in GitHub's web interface!
+
+Before starting to work on your next pull request, run the following command to sync your local repository with the remotes:
+
+```console
+$ git fetch --all
+$ git checkout main
+$ git merge
+```
+
 ---
 
 To avoid committing code that violates our style guide, we strongly advise you to install [*pre-commit*] and its hooks:

changelog.d/1105.change.md

@@ -0,0 +1 @@
+Added instructions for pull request workflow to `CONTRIBUTING.md`.