Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

35 lines (24 loc) · 1.24 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Development Setup

  1. Create a fork this repo
  2. Create branch with your username

Pull Request Process

  1. Ensure your code compiles. Run make before creating the pull request.
  2. If you're adding new external API, it must be properly documented.
  3. The commit message is formatted as follows:
   component: <summary>

   A paragraph explaining the problem and its context.

   Another one explaining how you solved that.

   <link to the bug ticket>
  1. You may merge the pull request in once you have the sign-off of the maintainers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Issue tags

  • "Bug": Something that should work is broken
  • "Enhancement": AKA feature request - adds new functionality
  • "Hacktoberfest": Part of hacktoberfest program
  • "Task": Something that needs to be done that doesn't really fix anything or add major functionality. Tests, engineering, documentation, etc.