From 9f6779e9f186d194fd853ca5f0a04efde846595e Mon Sep 17 00:00:00 2001 From: lucaronin Date: Fri, 24 Apr 2026 11:46:35 +0200 Subject: [PATCH] docs: add contributing guide --- .github/CONTRIBUTING.md | 49 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..e8fc7492 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,49 @@ +# Contributing to Tolaria + +Thanks for being here! Tolaria is still early, and every bug report, idea, and contribution genuinely helps shape the app. + +## 🗳️ Where to share what + +To keep things clean: + +- 🐛 Bugs → GitHub Issues +- 💡 Feature requests / ideas → Canny • + +If you have a feature idea, please check Canny first and upvote it if it already exists. + +## 📥 Pull requests are welcome + +PRs are very welcome. + +A few things to keep in mind before opening one: + +- Bug fixes are always great +- Small improvements are great too +- For bigger features, please check Canny first before building + - Try to avoid things that are already marked **in progress** + - Requests marked **planned** are usually great contribution targets +- Keep PRs small, focused, and easy to review +- Include a short explanation of the problem and your solution +- Follow the dev process described in Tolaria’s `AGENTS.md` (tests, code health, etc.) +- Avoid bundling unrelated refactors into the same PR + +If you want to contribute a feature, the best place to start is here: + +## 📋 What makes a good bug report + +If you open a bug report on GitHub, it really helps to include: + +- your Tolaria version +- your OS version +- steps to reproduce +- what you expected to happen +- what actually happened +- screenshots or screen recordings if useful + +The clearer the report, the easier it is for us to reproduce and fix it. + +## 🙏 Thank you + +Tolaria is getting better because people care enough to try it, report what’s broken, suggest what’s missing, and contribute improvements. + +That means a lot. Thanks for helping build it.