Skip to content

Latest commit

 

History

History
73 lines (46 loc) · 5.36 KB

CONTRIBUTING.md

File metadata and controls

73 lines (46 loc) · 5.36 KB

Contributing to [Your Project Name]

First off, thank you for considering contributing to [Your Project Name]. It's people like you that make [Your Project Name] such a great tool.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for [Your Project Name]. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible.

Before Submitting A Bug Report

  • Check the FAQs on the forum for a list of common questions and problems. You might be able to find the cause of the problem there.
  • Determine which repository the problem should be reported in.
  • Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

How Do I Submit A Good Bug Report?

Bugs are tracked as GitHub issues. After you've determined which repository your bug is related to, create an issue on that repository and provide the following information:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as much detail as possible.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for [Your Project Name], including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.

Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible.

Before Submitting An Enhancement Suggestion

  • Check the FAQs on the forum where enhancing requests are tracked. You might find that the enhancement has already been requested or is even being worked on.
  • Perform a cursory search to see if the enhancement has already been suggested.
  • If it has, add a comment to the existing issue instead of opening a new one.

How Do I Submit A Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. After you've determined which repository your enhancement suggestion is related to, create an issue on that repository and provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as much detail as possible.
  • Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of [Your Project Name] which the suggestion is related to.
  • Explain why this enhancement would be useful to most [Your Project Name] users and isn't something that can or should be implemented as a community plugin.

Pull Requests

  • Please follow the coding conventions used throughout the project. Coding conventions are mentioned below.
  • Include meaningful commit messages in your contributions.
  • Please create a pull request with the master branch as the base.

Coding Conventions

  • We follow the standard JavaScript style guide.
  • Always use spaces, never tabs.
  • Always use double quotes for strings.

Acknowledgments

This document is based on the open-source contribution guidelines for Facebook's Draft.

Final Notes

Thank you again for taking the time to contribute to [Your Project Name]! We appreciate your effort and are looking forward to improving [Your Project Name] together with you!