Skip to content

Commit fb8d4e9

Browse files
committed
some updates to Contributing.rst
1 parent 34dc4a9 commit fb8d4e9

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

docs/dev/Contributing.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,37 @@ Pull request guidelines
120120
or add "WIP" to the title. Otherwise, your pull request may be reviewed and/or
121121
merged prematurely.
122122

123+
* Avoid using force pushes to your pull request branch after it has been reviewed,
124+
as this can make it difficult for reviewers to see what has changed since their
125+
last review. If you need to make changes, consider creating a new commit instead
126+
of amending or rebasing. We neither enforce nor recommend a "single commit" rule; if you do
127+
choose to squash your commits, please ensure that the commit message is clear and descriptive of the changes made.
128+
If your pull request has an unusually large number of commits, a maintainer may
129+
request that you squash your commits into a smaller number of commits before merging.
130+
131+
* All pull requests must be accompanied by a description of the changes made, and
132+
any relevant information for reviewers. If your pull request addresses an
133+
issue, please include a reference to that issue in the description (e.g.
134+
"Fixes #1234"). If your pull request is related to another pull request, please
135+
include a reference to that pull request in the description (e.g. "Related to
136+
#1234").
137+
138+
* All pull requests which have user facing changes, including all new features, bug fixes, or
139+
changes to existing functionality, must include an entry in the "Future" section of
140+
the changelog for the relevant repository. If your pull request is merged, this entry
141+
will be added to the appropriate changelog. These entries are used when preparing the release
142+
notes for each release, so please be sure to include a clear and concise description
143+
of the changes made. See `build-changelog` for more information on the changelog format.
144+
Changes that do not require a changelog entry are mainly those that are purely internal,
145+
such as refactoring not intended to change semantics, code cleanup, changes to CI implementation
146+
or to documentation, or changes directly related to the release process. When in doubt,
147+
assume a changelog entry will be required.
148+
149+
* Pull requests that add or modify tools must include a corresponding update to the documentation
150+
for that tool. Similarly, pull requests that add or modify either the C++ or Lua APIs
151+
must include a corresponding update to the appropriate API documentation.
152+
See `docs-standards` for details.
153+
123154
Other ways to help
124155
==================
125156
DFHack is a software project, but there's a lot more to it than programming.

0 commit comments

Comments
 (0)