Skip to content

Commit be83495

Browse files
authored
feat: add contributing guide (#132)
2 parents fab2f6b + 9e354fb commit be83495

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing Guidelines
2+
3+
_Pull requests, bug reports, and all other forms of contribution are welcomed!_
4+
5+
This guide serves to set clear expectations for everyone involved with the project so that we can improve it together.
6+
7+
## Writing Commit Messages
8+
9+
Follow the [Conventional Commit style](https://www.conventionalcommits.org/en/v1.0.0/).
10+
11+
## Submitting Pull Requests
12+
13+
**Note: All contributions will be licensed under the project's license.**
14+
15+
- **Smaller is better.** Submit **one** pull request per bug fix or feature. A pull request should contain isolated changes pertaining to a single bug fix or feature implementation. **Do not** refactor or reformat code that is unrelated to your change. It is better to **submit many small pull requests** rather than a single large one. Enormous pull requests will take enormous amounts of time to review, or may be rejected altogether.
16+
17+
- **Coordinate bigger changes.** For large and non-trivial changes, open an issue to discuss a strategy with the maintainers. Otherwise, you risk doing a lot of work for nothing!
18+
19+
- **Follow existing coding style and conventions.** Keep your code consistent with the style, formatting, and conventions in the rest of the code base. When possible, these will be enforced with a linter. Consistency makes it easier to review and modify in the future.
20+
21+
- **Promptly address any CI failures**. If your pull request fails to build or pass tests, please push another commit to fix it.
22+
23+
- **[Resolve any merge conflicts](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github)** that occur.

0 commit comments

Comments
 (0)