From 754b83afa1186e14aeaf0ed08822e50a776d0fb2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vlado=20Paji=C4=87?= Date: Wed, 19 Nov 2025 12:54:17 +0100 Subject: [PATCH 1/3] add contribution --- README.md | 5 ++++- docs/contributing.md | 19 +++++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 docs/contributing.md diff --git a/README.md b/README.md index 794f960..0428fd4 100644 --- a/README.md +++ b/README.md @@ -202,7 +202,10 @@ Your sponsorship will help sustain development, introduce new features, and main ## 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 From ba387f08313e5a6962b05b27a7e50f822f301aed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vlado=20Paji=C4=87?= Date: Wed, 19 Nov 2025 13:02:05 +0100 Subject: [PATCH 2/3] docs --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 0428fd4..b9494c4 100644 --- a/README.md +++ b/README.md @@ -200,6 +200,8 @@ 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 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! From 3c9ebd0f84e5dd25f3cdcfcfac5548e151d19bed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vlado=20Paji=C4=87?= Date: Wed, 19 Nov 2025 13:04:06 +0100 Subject: [PATCH 3/3] update --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b9494c4..99d4dd2 100644 --- a/README.md +++ b/README.md @@ -200,7 +200,7 @@ 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. +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