Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (25 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

40 lines (25 loc) · 1.62 KB

How to contribute

🌟 You are awesome if you are reading this 🌟
🙌 Thank you for taking time to contribute to this repo

Please follow these guidelines to the extent possible. We can always move away, re-negotiate all of these, but following these makes our life easier to maintain and enhance it.

Table of Contents

What to know before hand?

  • Go. Well it's a simple language
  • Some bit of experience with kafka and it's working would be really helpful. I'm not pro myself :)

That's it !!

What if I found a bug?

  • Please use github issues, and choose Bug Report to report it.

It contains bunch of checklist which would help us recreating, debugging and fixing things faster.

What if I want to add a new feature?

I have tried to keep the domain constrained but am always open to implement new features which would make life of user easier. We can discuss over it, on github issues.
Do use Feature Request to raise a new feature request.

What if I want to contribute by making code changes ?

  1. use TDD while development to the extent possible. For rest of the cases, at-least always add a unit test for any code change.
  2. For commit messages: follow Conventional Commits Specification
  3. While raising PR, make sure, all the tests passes.