Skip to content

Latest commit

 

History

History
22 lines (13 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

22 lines (13 loc) · 1.76 KB

How to Open an Issue

Create an issue using the appropriate template.

Choose a short, descriptive title. Briefly explain what you think needs changing.

How to Submit a Pull Request

  1. When you're ready to submit your work, push your changes to your fork. Ensure that your fork is synced with main.
  2. You can submit a draft PR or a regular PR. If your work is not yet ready for review and merge, choose a draft PR. When your changes are ready to be reviewed, you can convert to a regular PR. See how to change the stage of a PR for more.

You may want to allow edits from maintainers so we can help with small changes like fixing typos.

Once you've submitted your ready-for-review PR, we'll review it. We may comment to ask for clarification or changes, so please check back in the next few days.

To increase the chances that your PR is merged, please make sure that:

  1. You've followed the guidelines above for associating your work with an issue.
  2. Your work is PEP8 linted.
  3. Your code snippets are correct, well-tested, and commented where necessary for understanding.

Once the PR is complete, we'll merge it! At.