Skip to content

Commit 6cdf46f

Browse files
authored
update contributing guide about PR merging (#88)
* update contributing guide about PR merging * update readme with links to docs
1 parent 2e06e30 commit 6cdf46f

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

.github/CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,8 @@ Don't be afraid to ask for help with anything on this project. DMs are open!
4040
- The Copilot PR review is a useful feature - it often catches easy to miss
4141
copy-paste errors, spelling/grammar mistakes, and other things. Be cautious
4242
though - it can make mistakes, and always validate the issues it finds.
43+
- Only *squash merging and rebase merging* into main are allowed. Don't worry
44+
about this too much, but if you don't know which to choose:
45+
- Choose a squash merge if the individual commits in the PR don't matter very
46+
much and/or the change is relatively atomic.
47+
- Choose a rebase merge if the individual commits in the PR do matter.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# api.acmcsuf.com
22

3-
ACM at CSUF club API for managing events, announcements, forms, and other services! See the `developer-docs/` directory for more information on using and contributing to this project.
3+
ACM at CSUF club API for managing events, announcements, forms, and other services! Keep reading for information on setting up this project locally, and see the [contributor guide](./.github/CONTRIBUTING.md) and [`developer-docs/`](./developer-docs) for more information on using and contributing to this project.
44

55
---
66

0 commit comments

Comments
 (0)