Skip to content

Guidelines

Pranay Marella edited this page Aug 27, 2020 · 1 revision

Contribution Guidelines

In order to contribute to our project, please adhere to our guidelines.

Reporting Bugs

To report a bug, please file a new issue with a clear and descriptive title and with the bug label. In the description, please provide an in-depth explanation of what problem is and the steps that we can follow to reproduce the problem. Any attachments showing the problem are greatly appreciated.

Suggesting Enhancements

To suggest an enhancement, please file an issue with the request enhancement label and explain the enhancement that you would like to see implemented.

Contribute to our codebase

If you would like to contribute to our codebase, look at issues with the label help wanted to see what features we would like contributors for. To set up your environment to contribute, follow the setup page on our wiki.

Pull Requests

Please follow the pull request template to raise a new pull request.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less

Clone this wiki locally