Skip to content

Latest commit

 

History

History
90 lines (56 loc) · 5.44 KB

CONTRIBUTING.md

File metadata and controls

90 lines (56 loc) · 5.44 KB

Contribution Guidelines & FAQ

Table of Contents

How to Contribute

Did you find a bug?

  • Ensure the bug was not already reported by searching the Issues filed on this repository.

  • If you're unable to find an open Issue addressing the problem, create a new Issue from the Bug Report template. Be sure to include a descriptive title and complete the template prompts with as much relevant information as possible.

Did you fix a bug?

  • Fork the project repository.

  • Commit your fixes to a new branch on your fork.

  • Open a new GitHub pull request from your new branch.

  • Be sure to include a descriptive title and complete the template prompts with as much relevant information as possible.

Did you fix whitespace, format code, or make a purely cosmetic patch?

Changes that are cosmetic in nature and do not add anything substantial to the useability, stability, functionality, or testability of the project or documentation may remain open until a functional fix or upgrade is necessary.

If a cosmetic/superficial patch is submitted during Hacktoberfest, it will be declined as spam.

Do you have a request for documentation improvements?

  • Ensure the request was not already reported by searching the Issues filed on this repository.

  • If you're unable to find an open Issue addressing the problem, create a new Issue from the Documentation Request template. Be sure to include a descriptive title and complete the template prompts with as much relevant information as possible.

Do you intend to add a new feature or change an existing one?

  • Ensure the request was not already reported by searching the Issues filed on this repository.

  • Create a new Issue from the Feature Request template. Be sure to include a descriptive title and complete the template prompts with as much relevant information as possible. This will give the community an opportunity to provide feedback while you work on your code.

  • Fork the project repository.

  • Commit your feature/changes to a new branch on your fork.

  • Open a new GitHub pull request from your new branch.

  • Be sure to include a descriptive title and complete the template prompts with as much relevant information as possible.

If you have a feature request but you can't implement it yourself or don't know where to start, you can still file a feature request. However these projects are community-supported, meaning that it may take some time to get a response, particularly on older or less frequently followed/forked projects.

Do you have other questions about this project?

Create a new Issue from the Question template. Be sure to include a descriptive title and any details or screenshots needed to support your question.

Contributor Resources

Project Resources

Technical Resources

Attribution

These contribution guidelines are based on the Ruby on Rails contribution guidelines.