Skip to content

Latest commit

 

History

History
56 lines (32 loc) · 2.65 KB

CONTRIBUTE.md

File metadata and controls

56 lines (32 loc) · 2.65 KB
Raw

Contributing

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

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

Contributing to Kosh takes 4 easy steps

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

👋Say Hi

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

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

🔨Do your thing

The very first thing you should do is be able to access Kosh and play around with it. There are two ways to do so

  • Request Access to our publicly hosted Kosh (link to the request access form)
  • Launch Kosh on your own machine (link to local-development.md)

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.

Once you have a local instance of Kosh running, you can make the changes you want to the code. Test the features and add appropriate documentation for it if needed.

📞Discuss

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/tea on slack 🙂

Licence

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

References

  • Gatsby JS documentation
  • Coral Project (link)