Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

55 lines (39 loc) · 2.12 KB
Raw

Contributing

Table of Contents

Read through these guidelines before you get started:

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

Questions & Concerns

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

Issues & Bugs

Submit an issue or pull request with a fix if you find any bugs in the project. See below for instructions on sending in pull requests, and be sure to reference the code style guide first!

When submitting an issue or pull request, make sure you're as detailed as possible and fill in all answers to questions asked in the templates. For example, an issue that simply states "X/Y/Z isn't working!" will be closed.

Feature Requests

Submit an issue to request a new feature. Features fall into one of two categories:

  1. Major: Major changes should be discussed with me via email. I'm always open to suggestions and will get back to you as soon as I can.
  2. Minor: A minor feature can simply be added via a pull request.

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. Make sure your feature or fix doesn't break the project! Test thoroughly.
  3. Commit your changes, and please leave a detailed commit message.
  4. Push your branch to your forked repo on GitHub: git push origin my-branch
  5. Submit a pull request
  6. If any changes are requested by the project maintainers, please make them and follow the steps until the changes are merged in.