mirror of
https://github.com/digital-asset/daml.git
synced 2024-09-11 04:45:57 +03:00
Clean up the guidelines for PR title/description (#427)
This commit is contained in:
parent
6110d4be3a
commit
86b16997af
@ -28,7 +28,7 @@ For Git commit messages, our principle is that `git log --pretty=oneline` should
|
||||
|
||||
- Read this document (contribution guidelines).
|
||||
- Does your PR include appropriate tests?
|
||||
- Make sure your PR title and description makes it easy for other developers to understand what the contained commits do.
|
||||
- Make sure your PR title and description makes it easy for other developers to understand what the contained commits do. The title should say what the changes do. The description should expand on what it does (if not obvious from the title alone), and say why it is being done.
|
||||
- If your PR corresponds to an issue, add “Fixes #XX” to your pull request description. This will auto-close the corresponding issue when the commit is merged into master and tie the PR to the issue.
|
||||
- If your PR includes user-facing changes, you must add a line describing the change to the [release notes](docs/source/support/release-notes.rst) as part of your PR.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user