Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

41 lines (30 loc) · 1.51 KB

Contributing to Kafta

Thank you so much for contributing to Kafta. We appreciate your time and help. Here are some guidelines to help you get started.

Code of Conduct

Be kind and respectful to the members. Take time to educate others who are seeking help.

Questions

If you have questions regarding Kafta, feel free to ask it in the issues

Filing a bug or feature

  1. Before filing an issue, please check the existing issues to see if a similar one was already opened. If there is one already opened, feel free to comment on it.
  2. If you believe you've found a bug, please provide detailed steps of reproduction.
  3. If you'd like to see a feature or an enhancement please open an issue with a clear title and description of what the feature is and why it would be beneficial to the project and its users.

Submitting changes

  1. Since this is golang project, ensure the new code is properly formatted to ensure code consistency. Run make all.
  2. It's recomend to open issue before to create some code, it's help you to understand if the change make sense for the Kafta

Quick steps to contribute

  1. Fork the project.
  2. Download your fork to your PC (git clone https://github.com/your_username/kafta && cd kafta)
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Make changes and run (make all)
  5. Add them to staging (git add .)
  6. Commit your changes (git commit -m 'Add some feature')
  7. Push to the branch (git push origin my-new-feature)
  8. Create new pull request