Skip to content

Commit 4deb7c1

Browse files
committed
Add CONTRIBUTING.md
1 parent 006cf93 commit 4deb7c1

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

CONTRIBUTING.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# 💚 Contributing to WARDuino
2+
3+
## ✨ How Can I Contribute?
4+
5+
If you want to help with development, issues on the [roadmap](https://github.com/orgs/TOPLLab/projects/1) with low priority are a good starting point.
6+
7+
Any sort of contribution is welcome! Including, but not limited to:
8+
9+
- Report a bug you identified
10+
- Write code which enhances the system or fixes an issue
11+
- PRs that port WARDuino to new platforms, and tutorials to use WARDuino on new boards
12+
13+
## 🎨 Style Guide
14+
15+
### Commit Messages
16+
17+
- Capitalize the first line and each paragraph
18+
- Use present tense (_"Add feature ..."_ instead of _"Added feature ..."_)
19+
- Use the imperative mood (_"Fix delay ..."_ instead of _"Fixes delay ..."_)
20+
- Do not end the subject line with a period
21+
- Use the body to explain what and why you have done something, refer to issues and PRs if you want
22+
23+
Check out the [guidelines for commit messages](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53) for more examples and recommendations.
24+
25+
### Branches
26+
27+
- Follow a simple naming scheme that clearly describes the topic you are working on
28+
29+
### Pull Requests
30+
31+
- Use the description field to describe what you are introducing or changing in your branch
32+
- Try to make small PRs that fix/introduce a single item
33+
34+
### Merge Branches
35+
36+
- You cannot push directly to `main`, please create a branch with your changes and open a PR to request code review before merging
37+
- You can use a ["Draft" PR](https://github.blog/2019-02-14-introducing-draft-pull-requests/) if your work is not done yet
38+
- Verify that all status checks are passing
39+
- Click "Ready to Review" to request merging your branch into `main`
40+
- Since PRs should introduce a single cohesive change to the code, the preferred merge method is [Squash and merge](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits)
41+

0 commit comments

Comments
 (0)