Skip to content

Commit 33ea9d9

Browse files
authored
docs: add more detail for PR expectations (#10)
Make sure we describe the project's merge strategy and expectations for pull requests. Signed-off-by: Eric Ernst <[email protected]>
1 parent 10de7a5 commit 33ea9d9

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,20 @@ To make a pull request, use [GitHub](https://github.com/apple/containerization/c
3030
> You can do this by filing a [GitHub issue](https://github.com/apple/containerization/issues/new)
3131
> This will save time and increases the chance of your pull request being accepted.
3232
33+
We use a "squash and merge" strategy to keep our `main` branch history clean and easy to follow. When your pull request
34+
is merged, all of your commits will be combined into a single commit.
35+
36+
With the "squash and merge" strategy, the *title* and *body* of your pull request is extremely important. It will become the commit message
37+
for the squashed commit. Think of it as the single, definitive description of your contribution.
38+
39+
Before merging, we'll review the pull request title and body to ensure it:
40+
41+
* Clearly and concisely describes the changes.
42+
* Uses the imperative mood (e.g., "Add feature," "Fix bug").
43+
* Provides enough context for future developers to understand the purpose of the change.
44+
45+
The pull request description should be concise and accurately describe the *what* and *why* of your changes.
46+
3347
#### Fomatting Contributions
3448

3549
Make sure your contributions are consistent with the rest of the project's formatting. You can do this using our Makefile:

0 commit comments

Comments
 (0)