Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

45 lines (28 loc) · 1.58 KB

Contributing

We welcome all contributions to this project! If you notice a bug or have a feature request, please open up an issue. All contributors must abide by our code of conduct.

Types of Contributions

Report Bugs

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Write Documentation

You can never have enough documentation! Please feel free to contribute to any part of the documentation, such as the official docs, docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

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 :)

Get Started!

Ready to contribute? Here's how to set up for local development.

  1. For this repository.
  2. Make changes!
  3. Commit your changes and submit a pull request.

Maintainers

This repository is currently mainted by @casesarw0, @florawendy19, @nik11susan, @Yurui-Feng.