Skip to content

Latest commit

 

History

History
46 lines (35 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

46 lines (35 loc) · 2.14 KB

Contributing to go-analyse

Thank you so much for contributing to go-analyse. I appreciate your time and help. Here are some guidelines to help you get started.

Code of Conduct

Be kind and respectful to the members of the community. Take time to educate others who are seeking help. Harassment of any kind will not be tolerated.

Questions

If you have questions regarding go-analyse, feel free to ask it by raising an Issue and label it as a question.

Filing a bug or feature request

  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, the version of go-analyse and anything else you believe will be useful to help troubleshoot it (e.g. OS environment, environment variables, etc...). Also state the current behavior vs. the expected behavior.
  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. By contributing code to this repository you acknowledge that you have the rights to do so and that the works you provide is licensed under the same MIT license as this project. See LICENSE for the MIT license.
  2. Tests: If you are submitting code, please ensure you have adequate tests for the feature or bug fix. Please run make test and make check.
  3. Since this is a golang project, ensure the new code is properly formatted to ensure code consistency. Run make check.

Quick steps to contribute

  1. Fork the project.
  2. Download your fork to your computer (git clone https://github.com/your_username/go-analyse && cd go-analyse)
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Make changes and run tests (make test)
  5. Add them to staging (git add .)
  6. Commit your changes (git commit -m 'Please be specific about what you have added/changed and why')
  7. Push to the branch (git push origin my-new-feature)
  8. Create a new pull request