Skip to content

Latest commit

 

History

History
69 lines (49 loc) · 4.49 KB

CONTRIBUTING.md

File metadata and controls

69 lines (49 loc) · 4.49 KB

Contributing to Auto Anki 👍 🥳

We would like to thank you for showing interest in Auto Anki. You are most welcome to suggest improvements and contribute to the project. We are delighted when people want to contribute to Auto Anki!

How Can I Contribute?:

Each contribution counts for our project. So, make sure to classify which is yours.

Reporting Bugs 🐛

This section guides you through submitting a bug report for this repository. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎. Before creating bug reports, please perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one. Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

How Do I Submit A (Good) Bug Report? ❔

Bugs are tracked as GitHub issues. After you've determined which repository your bug is related to, create an issue on that repository and provide the following information by filling in the template. Explain the problem and include additional details to help a developer reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. Along with it, provide the details regarding the name and version of OS, Python version, configuration of the environment, if used any.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/paste able snippets, which you use in those examples. Ifyou're providing snippets in the issue, use Markdown code blocks.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • If the problem is related to performance or memory, include details of the errors encountered with your report.
  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.

Suggesting Enhancements and new features

This section guides you through submitting an enhancement suggestion for this project:

**How Do I Submit A (Good) Enhancement Suggestion?**🤔

Enhancement suggestions are tracked as GitHub issues. Create an issue on that repository with an enhancement or feature tag and provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include copy/paste able snippets which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.

Pull Requests

The process described here has several goals:

  • Maintain code quality by following some basic PEP 8 standards
  • Fix problems that are important to users
  • Enable a sustainable system for this project's maintainers to review contributions Please follow these steps to have your contribution considered by the maintainers:
  1. Follow the styleguides
  2. After you submit your pull request, verify that all status checks are passing
  3. What if the status checks are failing?
  4. 
 While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted. Please include the following while creating a Pull Request:
  • Link to the issue it addresses, if issues exist.
  • A short description of what the Pull Request fixes or does (in case of a feature)

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line
  • When only changing documentation, include [ci skip] in the commit title

Attribution

These Contributing guidelines are adapted from the Atom's contributing guidelines.