Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

35 lines (26 loc) · 1.94 KB
Raw

Contributing Guidelines

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. Contributions to this project are released to the public under the project's open source license.

This project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Submitting a pull request

  1. Fork and clone the repository
  2. Create a new branch: git checkout -b my-branch-name
  3. Make your change, add tests, and make sure the tests still pass
  4. Push to your fork and submit a pull request
  5. Pat your self on the back and wait for your pull request to be reviewed and merged.

Formatting

  • Folder name must be in snake_case
  • Folder must contain README.md file with the following informationa.
    • Short title [Optional]
    • Description
    • Installation [If any]
    • Usage
  • Update repository README.md and include a link to and small description on Available Scripts ✔️ section.
  • Continue to follow the alphabetical ordering that is in place Available Scripts ✔️ section.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Follow standards for style and code quality
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Resources