diff --git a/README.md b/README.md index 794f960..99d4dd2 100644 --- a/README.md +++ b/README.md @@ -200,9 +200,14 @@ Your sponsorship will help sustain development, introduce new features, and main ⭐ Love this project? Star it! +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. + ## Contribution -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! +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! + +See the [contributing](/docs/contributing.md) page for more details before opening a PR. +--- Happy coding 🌞 diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 0000000..b0b7328 --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,19 @@ +# Contribution + +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! + + +## PR Guidelines + +Before requesting a review, please ensure that your code passes the following checks: + +- unit tests: `make test` +- coverage: `make check-coverage` +- lints: `make lint` + +Once all checks have passed, you may request a review from the maintainers (@vladopajic). + + +--- + +Happy coding 🌞 \ No newline at end of file