Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.69 KB

contributing.md

File metadata and controls

46 lines (31 loc) · 1.69 KB

Contributing

Follow these guidelines if you'd like to contribute to the project!


Table of contents

Read through these guidelines before you get started:

  1. Questions & Concerns
  2. Issues & Bugs
  3. Submitting Pull Requests
  4. Code Style

Questions & concerns

If you have any questions about using or developing for this project, reach out to weeyin83 or send an email.

Issues & bugs

Submit an issue or pull request with a fix if you would like to contribute to the checklist.. See below for instructions on sending in pull requests.

Submitting pull requests

Before you do anything, make sure you check the current list of pull requests to ensure you aren't duplicating anyone's work. Then, do the following:

  1. Fork the repository and make your changes in a git branch: git checkout -b my-branch base-branch
  2. Read and follow the code style guidelines.
  3. Make sure your feature or fix doesn't break the project! Test thoroughly.
  4. Commit your changes, and be sure to leave a detailed commit message.
  5. Push your branch to your forked repo on GitHub: git push origin my-branch
  6. Submit a pull request and hold tight!
  7. If any changes are requested by the project maintainers, make them and follow this process again until the changes are merged in.