Skip to content

Latest commit

 

History

History
47 lines (26 loc) · 2.27 KB

contributing.md

File metadata and controls

47 lines (26 loc) · 2.27 KB

Contributing

Firstly, we are really grateful that you are considering contributing to Tattle. We welcome contributions of all sorts - filing a bug report, suggesting improvements, proposing new feature, adding documentations, writing tests etc.

By contributing to Tattle, you are agreeing to our community guidelines (will be linked soon)

Contributing to Tattle takes 4 easy steps

  1. 👋Say Hi
  2. 🔨Do your thing
  3. 📞Tell us
  4. 🎉Celebrate

👋Say Hi

The very first thing you should do is letting us know that you are interested in contributing by the following means :

  1. If you are unsure about how to contribute, simply join our Slack and introduce yourself and mention what interests you about us. We'll reach out and assist you further.
  2. If there's a particular improvement you want to suggest, or a bug you want to fix, simply create a Github Issue regarding it and we'll reach out to assist you further.

🔨Do your thing

The Running Locally section above should help you access and run the code. Once you are able to run the code locally, you can make the changes you want. Test the features and add appropriate documentation for it if needed.

Pair programming

We offer pair programming sessions with community members to familiarize them with the product and the code base. This will give you an opportunity to clarify any doubts regarding the codebase and the features that interest you.

📞Tell us

All code changes happen via pull request. We use Github Flow. The easiest way to let us know if you want to combine your changes into the core code is to make a Pull Request (PR)

In your PR, please mention the following :

  • What does this PR do?
  • How do we test this PR?

We don't strictly follow test driven development (TDD) but any contributions that include tests are greatly appreciated.

🎉Celebrate

We typically review a PR within 2-3 days. We might offer you some feedback to your PR and merge it! If you reached till this stage, Congratulations and join us afterwards for virtual coffee and tea on slack 🙂

Licence

When you submit code changes, your submissions are understood to be under the same licence that covers the project - GPL . Feel free to contact the maintainers if that's a concern.