Skip to content

Latest commit

 

History

History
20 lines (14 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

20 lines (14 loc) · 1.38 KB
Raw

Contribution guide

First of all, thank you for taking the time to contribute! 🎉

When contributing to this project, please first create an issue to discuss the change you wish to make before making a change.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome 😊.

Before making a pull request

  1. Follow the instructions in the Contributing section of the README.md
  2. Check out a new branch and add your modification.
  3. If possible, write tests, and ensure that they pass. This project uses unittest.
  4. Update README.md for your changes. Please make sure that the Table of Contents is up to date. DocToc makes this pretty easy, as you simply run doctoc README.md (You can install it globally on your system via npm install -g doctoc).
  5. Commit your changes. If you do it via cz commit or npm run commit, you'll get some fancy prompts to help you to appropriately categorize your commit.
  6. Send a pull request 🙏