Skip to content

Latest commit

 

History

History
75 lines (46 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

75 lines (46 loc) · 3.09 KB
Raw

Contributing

First off, thank you for considering contributing to this project. It's people like you that make it such a great tool.

Code of Conduct

This project adheres to a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

What we are looking for

This is an open-source project, and we welcome contributions of all kinds: new features, bug fixes, documentation, examples, or enhancements to existing features. We are always thrilled to receive contributions from the community.

How to contribute

If you've never contributed to an open-source project before, here are a few steps to get you started:

Reporting Issues

Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. You can search through existing issues and pull requests to see if someone has reported one similar to yours.

When you are creating a bug report, please include as much detail as possible.

Pull Requests

  • Fork the repository and create your branch from main.
  • If you've added code that should be tested, add tests.
  • If you've changed APIs, update the documentation.
  • Ensure the test suite passes.
  • Make sure your code lints.
  • Issue that pull request!

Getting started

For something that is bigger than a one or two-line fix:

  1. Create your own fork of the code.
  2. Do the changes in your fork.
  3. If you like the change and think the project could use it:
    • Be sure you have followed the code style for the project.
    • Note the Code of Conduct.
    • Send a pull request.

How to report a bug

If you find a security vulnerability, do NOT open an issue. Email [email protected] instead.

In order to help us understand and resolve your issue quickly, please include as much information as possible, including:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give a sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.

How to suggest a feature or enhancement

If you find yourself wishing for a feature that doesn't exist in the project, you are probably not alone. There are bound to be others out there with similar needs. Open an issue on our issues list on GitHub, which describes the feature you would like to see, why you need it, and how it should work.

Code review process

The core team looks at Pull Requests on a regular basis in a bi-weekly triage meeting. After feedback has been given, we expect responses within two weeks. After two weeks, we may close the pull request if it isn't showing any activity.

Community

Discussions about the project take place in this repository's Issues and Pull Requests sections. Anybody is welcome to join these conversations.

Wherever possible, we use GitHub to discuss changes and keep the decision-making process open.

Thank you!

Thank you for contributing!