Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

66 lines (45 loc) · 3.01 KB
Raw

Contributing to FlashcardX

Thank you for taking the time to help and improve FlashcardX!

We welcome a variety of contributions:

  • Reporting a bug
  • Proposing new features
  • Discussing the current state of the code
  • Submitting a bugfix
  • Becoming a maintainer

Table of Contents

Discussion, Issue Reports, and Suggestions

We do all of our discussion through Github issues. There, you can discuss FlashcardX and its code, suggest features with the enhancement label, report bugs with the bug label, and make other contributions.

Guidelines for Bug Reports

We treat all bug reports very seriously. In order to improve FlashcardX as quickly as possible, we appreciate detailed, thorough bug reports.

Excellent bug reports include the following:

  • Some kind of summary or background
  • Steps to reproduce the bug
  • What you expected to happen
  • What actually happened
  • Screenshots, if possible
  • Notes, if you have any

Guidelines for Suggestions

Excellent feature suggestions include the following:

  • A clear and descriptive title for your suggestion
  • A description of the need for your new feature, including at least one specific use case, with as many details as possible
  • A description of how someone would use your new feature, with as many details as possible
  • An outline of the exact behavior of your new feature, again with as many details as possible, ideally including examples
  • A description of how your feature is different from any similar previously suggested features, if any

Endorsing Suggestions

Endorsing other suggestions gives us a good gauge of what the FlashcardX community wants to see in our platform. If you see a proposed feature that you would like to see added, please leave a comment on the page containing the suggestion. This comment could be a simple statement showing your approval (e.g. "I like this!") or it could also list additional use cases in which the proposed feature would be useful which were not mentioned elsewhere.

Making Code Contributions

We handle our codebase and all changes through Github, so make a fork and a pull request if you want to contribute code. Below are the steps to making a proper contribution:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Do testing on the code to ensure you haven't introduced breaking changes
  5. Make sure your code lints.
  6. Issue that pull request!

License

Like all other files in this repo, these guidelines are licensed under the GPL 3.0