Skip to content

Latest commit

 

History

History
99 lines (66 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

99 lines (66 loc) · 2.82 KB

Contributing to Keepsimple

First off, thank you for taking the time to contribute! 🎉

We welcome contributions of all kinds - whether it’s fixing bugs, translating content, or just sharing an idea.
Please read through the following guidelines before you start. Also check out our README for more context about the project.

What We’re Looking For

We welcome contributions that:

  • Solve existing issues
  • Improve code quality or performance
  • Enhance the overall user experience
  • Help with translations or accessibility

How to contribute

  1. Fork this repo and create a new branch (git checkout -b your-feature-name)
  2. Make your changes (keep it focused)
  3. Test your changes locally
  4. Commit with a clear message
  5. Push and open a Pull Request (PR)

Please follow our code style and naming conventions. Ensure your code passes all lints and tests.

What Gets Merged

We merge contributions that:

  • Fix bugs or improve features
  • Improve accessibility or performance
  • Add tests or improve test coverage
  • Enhance translations
  • Are linked to a tracked issue

What Doesn’t Get Merged

We won’t merge contributions that:

  • Break functionality without prior discussion
  • Don’t follow code style or project goals
  • Are not linked to an issue
  • Include 500+ lines of changes without discussion
  • Add new features that weren’t proposed in the Issues tab

Pull Request Guidelines

  • Link your PR to an open issue by using Related to #123 or Closes #123 in the PR description Alternatively, you can create a branch directly from the issue page and open a PR from there, GitHub will auto-link them for you
  • Make sure your code passes all CI checks and tests
  • Keep PRs small and focused when possible
❓ What if status checks are failing? - Run all tests locally before pushing.
- If the issue seems unrelated to your change, leave a comment on the PR

Want to Contribute Without Coding?

You can still help by:

  • Sharing the project with others
  • Reporting bugs (❗️use the contribution label when creating an issue)
  • Translating the project (contact us via Telegram for details)

Community Guidelines

Please be respectful and inclusive in all interactions. We're here to learn and grow together.
Join the conversation in our Telegram group to share ideas, ask questions, and get help.

✨ Contributor Achievements ✨

We appreciate all contributions, big or small. Every effort counts, and each contributor will be recognized with a special achievement added to their Profile page.

Thanks again for being part of this journey!
Be Kind. Do Good. ❤️