Skip to content

Commit 0330666

Browse files
adamltysonlochhh
andauthored
Add PR message expectations (#295)
* Add PR message expectations * Fix indentation in development guidelines --------- Co-authored-by: lochhh <changhuan.lo@ucl.ac.uk>
1 parent a52d23d commit 0330666

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

docs/source/get-involved/development_guidelines.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,12 @@ one operating system.
5858

5959
* We will use [semantic versioning](https://semver.org/) for all projects.
6060

61-
## Pull requests
61+
## Pull requests (PRs)
6262
- Please submit _draft_ pull requests as early as possible (you can still push to the branch once submitted) to
6363
allow for discussion.
64+
- Please ensure that the title of your PR clearly explains its purpose. The "why" is more important than the "how"
65+
(which should be clear from the code and the PR description). We do not use any standards such as
66+
[Conventional Commits](https://www.conventionalcommits.org) so PR titles should not include this metadata.
6467
- One approval of a PR is enough for it to be merged.
6568
- Unless someone approves the PR with optional comments, the PR can be immediately merged by the approving reviewer.
6669
- Please merge via "Squash and Merge" on GitHub to maintain a clean commit history.

0 commit comments

Comments
 (0)