Skip to content

Commit

Permalink
Add some guidance on making PRs
Browse files Browse the repository at this point in the history
  • Loading branch information
bmerry committed Sep 19, 2023
1 parent 9b0a41c commit 3b51574
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions doc/dev-setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -166,3 +166,21 @@ environment variable :envvar:`SKIP=pip-compile` when committing.
to appear if the source directory is a prefix *as a string* of the virtual
environment path, even if the virtual environment is not inside the source
directory.
Making a pull request
---------------------
spead2 uses the normal Github workflow for pull requests. There are many
guides on the internet to writing good pull requests, such as
`this one <perfect-pr_>`_ or `this one <unwritten-pr_>`_.
A few points to note for spead2:

- Don't add to the changelog. The changelog for each release is generally
prepared just prior to each release. However, it is a good idea to write a
meaningful title for the pull request that could become the changelog entry.
- Once a pull request has been reviewed, don't force-push changes. Doing so
prevents the reviewer from seeing the difference between the
previously-reviewed version and your update. If you're a stickler for a neat
commit history, ask if you can rebase just prior to merging.

.. _perfect-pr: https://github.blog/2015-01-21-how-to-write-the-perfect-pull-request/
.. _unwritten-pr: https://www.atlassian.com/blog/git/written-unwritten-guide-pull-requests

0 comments on commit 3b51574

Please sign in to comment.