Skip to content

Latest commit

 

History

History
69 lines (43 loc) · 3.58 KB

CONTRIBUTING.md

File metadata and controls

69 lines (43 loc) · 3.58 KB
Raw

Contributing to CONTRIBUTING.md

First off, thanks for taking the time to contribute!

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution.

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the CONTRIBUTING.md Code of Conduct By participating, you are expected to uphold this code. Please report unacceptable behavior to <>.

I Have a Question

If you need to ask a question and need clarification, we recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into.
  • Provide the specific project and platform you are having the issue with. We will then take care of the issue as soon as possible.

I Want To Contribute

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

Reporting Bugs

Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions.
  • Collect information about the bug:
  • Is it possibly your input and the output that is causing it

How Do I Submit a Good Bug Report?

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue. (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
  • Explain the behavior you would expect and the actual behavior.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
  • Provide the information you collected in the previus section.

Once it's filed:

  • The project team will label the issue accordingly.
  • A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as needs-repro. Bugs with the needs-repro tag will not be addressed until they are reproduced.
  • If the team is able to reproduce the issue, it will be marked needs-fix, as well as possibly other tags (such as critical), and the issue will be left to be implemented by someone.

Submitting a Project

  • Make sure you title the project the same as the folder with all relevant information so the team can easilt find and approve the project submmission.
  • Make sure to include in the pull request that you are adding a new project to the repository
  • Make sure you have a relevant and meaningful description of the project in the pull request