Skip to content

Commit 858c746

Browse files
authored
chore(docs): add contributing page (#246)
1 parent a528d88 commit 858c746

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,9 +200,14 @@ Your sponsorship will help sustain development, introduce new features, and main
200200

201201
⭐ Love this project? Star it!
202202

203+
This tool is still not widely known, and giving the repository a ⭐️ is a simple, cost-free way to help it gain visibility. It’s a win-win for everyone: new users discover a useful tool they might have otherwise missed, and existing users benefit from a larger community where issues get identified sooner, improvements happen faster and new contributions help the project grow.
204+
203205
## Contribution
204206

205-
We welcome all contributions - whether it's fixing a typo, adding new features, or pointing out an issue. Feel free to open a pull request or issue to contribute!
207+
All contributions are welcome - whether you're fixing a typo, adding a new feature, or reporting an issue. Feel free to open a pull request or create an issue to contribute!
208+
209+
See the [contributing](/docs/contributing.md) page for more details before opening a PR.
206210

211+
---
207212

208213
Happy coding 🌞

docs/contributing.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Contribution
2+
3+
All contributions are welcome - whether you're fixing a typo, adding a new feature, or reporting an issue. Feel free to open a pull request or create an issue to contribute!
4+
5+
6+
## PR Guidelines
7+
8+
Before requesting a review, please ensure that your code passes the following checks:
9+
10+
- unit tests: `make test`
11+
- coverage: `make check-coverage`
12+
- lints: `make lint`
13+
14+
Once all checks have passed, you may request a review from the maintainers (@vladopajic).
15+
16+
17+
---
18+
19+
Happy coding 🌞

0 commit comments

Comments
 (0)