Skip to content
This repository was archived by the owner on Jul 1, 2022. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (37 loc) · 3.25 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 3.25 KB

Contributing to Ball

Firstly, thanks for taking the time to contribute to this project!

The following is a set of guidelines for contributing to Ball. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

How can I contribute?

How can I contribute?

Reporting Bugs

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. Create an issue and provide the following information by filling in the template.

Explain the problem and include additional details to help maintainers 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. When listing steps, don't just say what you did, but explain how you did it.
  • Provide specific examples to demonstrate the steps. Include links to files, or copy/pasteable snippets, which you use in those examples. If you'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.
  • Include screenshots and Videos which show you following the described steps and clearly demonstrate the problem. You can use OBS Studio to record videos on Windows, MacOS and Linux.
  • If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.

Submitting a suggestion

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues.

  • 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/pasteable 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.
  • Include screenshots and Videos which help you demonstrate the steps or point out the part of Ball which the suggestion is related to. You can use OBS Studio to record videos on Windows, MacOS and Linux.
  • Explain why this enhancement would be useful

Contributing Code

Pull Requests

The process described here has several goals:

  • Maintain Ball's quality
  • Fix problems that are important to users.
  • Engage the community in working toward the best possible Ball.

Styleguides

  • Try to follow PEP 8 as best as you can.