Skip to content
This repository was archived by the owner on Sep 12, 2023. It is now read-only.

Commit bd95d1d

Browse files
committed
Add contribution guidelines
1 parent cfc86b8 commit bd95d1d

File tree

2 files changed

+30
-1
lines changed

2 files changed

+30
-1
lines changed

CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contributing guidelines
2+
3+
Thank you for wanting to contribute to this project!
4+
5+
## Contributing code
6+
7+
There are a couple of things we are going to look out for in PRs and knowing them upfront is going to reduce the number of times we will be going back and forth, making things more efficient.
8+
9+
1. We have CI checks in place that validate formatting and code style.
10+
Make sure `dprint check` and `cargo clippy` both finish without any warnings or errors on every commit.
11+
If you don't already have `dprint` installed, you can obtain it in [various ways](https://dprint.dev/install/).
12+
2. All text documents (`CHANGELOG.md`, `README.md`, etc) should follow the [semantic linebreaks](https://sembr.org/) specification.
13+
3. We strive for atomic commits with good commit messages.
14+
As an inspiration, read [this](https://chris.beams.io/posts/git-commit/) blogpost.
15+
An atomic commit is a cohesive diff with formatting checks, linter and build passing.
16+
Ideally, all tests are passing as well but we acknowledge that this is not always possible depending on the change you are making.
17+
4. If you are making any user-facing changes, include a changelog entry.
18+
19+
## Contributing issues
20+
21+
When contributing a feature request, please focus on your _problem_ as much as possible.
22+
It is okay to include ideas on how the feature could be implemented but they shouldn't be the focus of your request.
23+
24+
For more loosely-defined problems and ideas, consider starting a [discussion](https://github.com/itchysats/itchysats/discussions/new) instead of opening an issue.

README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -137,4 +137,9 @@ cd taker-frontend && yarn run eslint
137137

138138
## Contact
139139

140-
Feel free to reach out to us on [Twitter](twitter.com/itchysats) or [Telegram](https://t.me/joinchat/ULycH50PLV1jOTI0).
140+
Feel free to reach out to us on [Twitter](twitter.com/itchysats), [Telegram](https://t.me/joinchat/ULycH50PLV1jOTI0) or [Matrix](https://matrix.to/#/!OSErkwZgvuIhcizfaI:matrix.org?via=matrix.org).
141+
142+
## Contributing
143+
144+
We encourage community contributions whether it be a bug fix or an improvement to the documentation.
145+
Please have a look at the [contributing guidelines](./CONTRIBUTING.md).

0 commit comments

Comments
 (0)