Skip to content
This repository was archived by the owner on Feb 26, 2024. It is now read-only.

Commit 28c6876

Browse files
authored
Merge branch 'develop' into davidmurdoch-patch-1
2 parents 3c5977b + 197c12a commit 28c6876

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

CONTRIBUTING.md

+31
Original file line numberDiff line numberDiff line change
@@ -174,3 +174,34 @@ These are guidelines, not rules. :-)
174174
- Do not use bash scripts for critical development or configuration.
175175
- Do not use CLI commands in npm scripts or build scripts that aren't available by default on supported platforms.
176176
- Push your code often (at least every-other day!), even broken WIP code (to your own branch, of course).
177+
178+
## Pull Requests
179+
180+
This section is mostly for the maintainers of Ganache, not individual contributors. You may commit with any messages you
181+
find useful.
182+
183+
We _always_ "Squash and Merge" Pull Requests into a single commit message when merging into the `develop` branch.
184+
185+
The "Squash and Merge" commit message _must_ be in the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) format:
186+
187+
```
188+
<type>[optional scope]: <description> (#PR Number)
189+
190+
[optional body]
191+
192+
[optional footer(s)]
193+
```
194+
195+
Example:
196+
197+
```
198+
fix: reduce bundle size and check size in CI (#1234)
199+
200+
Co-authored-by: TinusLorvalds <[email protected]>
201+
```
202+
203+
Notice how the description is in lowercase (except for initialisms/acronyms). The description should be clear and consise. The subject line does _not_ have to be fewer than 50 characters if making it shorter removes useful information.
204+
205+
Co-authors should be preserved.
206+
207+
This format is what drives our automated release process and helps makes releases go smoothly.

0 commit comments

Comments
 (0)