Skip to content

Latest commit

 

History

History
54 lines (32 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

54 lines (32 loc) · 2 KB
Raw

Contributing to Our Project

First off, thank you for considering contributing to our project. It's people like you that make this project such a great one.

How Can I Contribute?

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

If you have a suggestion (including new features and changes in existing features), please feel free to open an issue and clearly describe the issue. Include screenshots and animated GIFs in your issue whenever possible.

Your First Code Contribution

  • Fork this repository.
  • Create a branch: git checkout -b <branch_name>.
  • Make your changes and commit them: git commit -m '<commit_message>'
  • Push to the original branch: git push origin <project_name>/<location>
  • Create the pull request.

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible.

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

JavaScript Styleguide

All JavaScript must adhere to JavaScript Standard Style.

CSS Styleguide

All CSS must adhere to CSS Guidelines.

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

Code of Conduct

This project and everyone participating in it is governed by the Your Project Name Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].