Skip to content

Latest commit

 

History

History
85 lines (55 loc) · 5.86 KB

CONTRIBUTING.md

File metadata and controls

85 lines (55 loc) · 5.86 KB
Raw

Contributing to Promitor

First off, thank you for taking the time to contribute!

This guide provides guidelines on how to contribute, get involved or report feature requests & bugs. Following these guidelines helps maintainers and the community understand what your concern is and how we can approach it.

In this guide you can find some guidance on where you can help:

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.

Where Can I Help?

Promitor uses a Contribution License Agreement (CLA) which needs to be signed for all contributions and is handled by CLA Assistant.

The Contribution License Agreement (CLA) is required for all parties to align on the expectations of the contributions in order to avoid disputes in the future.

The CLA Assistant will walk you through the process during your first pull request.

Where Can I Help?

Unsure where to begin contributing to Promitor? You can start by looking through these beginner and help-wanted issues:

  • Beginner issues - issues are very small and good to learn how Promitor works.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Pull Requests

  • Always create an issue and discuss changes before sending PRs
    • Allow us to assign the issue to you and avoid multiple people working on the same thing.
    • This is to avoid wasting your time because it's not part of the roadmap or not as how we would approach it.
  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include thoughtfully-worded, well-structured OpenAPI specs when appropriate.

Requesting A Feature

This section guides you through submitting a feature request - We are open to everything.

Every feature request will be considered and determined if it's in scope of the project, what the customer demand is and what priority it has.

Before creating a new feature request, please check the issue tracker as you might find out that you don't need to create one. In that case, just join the discussion and explain your scenario.

When you are creating a feature request, please use the Feature Request template and describe what you would like to have and how this would help you.

How Do I Create A (Good) Feature Request?

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the feature request to set the scene.
  • Explain what you would like to see, how it could help and if it's blocking you.
  • Provide specific examples to demonstrate how you would expect it to work. This would help us get an understanding of what it should look like and how it should work.
  • We are open for suggestions on how to implement it in terms of runtime, configuration, deployment, etc
  • We are open for pull requests, but wait for confirmation first, see "Pull Requests".

Reporting Bugs

This section guides you through submitting a bug report for Promitor - Before creating bug reports, please check issue tracker as you might find out that you don't need to create one.

How Do I Submit A (Good) Bug Report?

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. For example, start by explaining how you started Promitor, e.g. which command exactly you used to start the Docker image. When listing steps, don't just say what you did, but explain what information the logs provided.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, 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.
  • If you're reporting that Promitor crashed, include a crash report with a stack trace from logs. Include the crash report in the issue in a code block or put it in a gist and provide link to that gist.

Include details about your configuration and environment:

  • Which version of Promitor are you using?
  • What's the name and version of the container host that you're using? Is it Docker, Kubernetes,...?
  • What configuration is it using and how does your scraping declaration look like?