Skip to content

Commit

Permalink
docs/development: Referencing issues in commit messages
Browse files Browse the repository at this point in the history
This change was made to my last accepted commit, so I presume it's
something I should be doing normally.

No changelog update because this is already covered by the tox-dev#3197
changelog going out in the next release.
  • Loading branch information
0cjs committed Jan 29, 2024
1 parent 2bcc3ec commit c08daed
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ section. This section contains only highlights; it's not a substitute for readin

- Lines wrapped at less than 120 characters. Lines should be wrapped at 120 characters, not the PEP-8 standard of 79.
- Variable names should be at least two characters long.
- If a commit references an issue, this should be noted in parentheses at the end of the summary line, e.g.
``(#1234)``. (It may still also be mentioned again in the comit body text.)

- Documentation is in `RST <https://docutils.sourceforge.io/docs/user/rst/quickref.html>`_ format; beware the
differences from GitHub Markdown. The tox ``docs`` and ``fix`` targets will catch only some RST errors; documentation
Expand Down

0 comments on commit c08daed

Please sign in to comment.