Skip to content

Latest commit

 

History

History
74 lines (55 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

74 lines (55 loc) · 2.13 KB
Raw

Contributing

Thank you for contributing to our project! Here are the steps and guidelines to follow when creating a pull request (PR).

Prometheus uses GitHub to manage reviews of pull requests.

  • If you have a trivial fix or improvement, go ahead and create a pull request, addressing (with @...) the maintainer of this repository (see MAINTAINERS.md) in the description of the pull request.

  • If you plan to do something more involved, first discuss your ideas on our mailing list. This will avoid unnecessary work and surely give you and us a good deal of inspiration.

  • Relevant coding style guidelines are the Go Code Review Comments and the Formatting and style section of Peter Bourgon's Go: Best Practices for Production Environments.

  • Be sure to sign off on the DCO

How to write a PR description

Describe your PR

In this section, provide a clear and concise description of what your PR does. This helps reviewers understand the purpose and context of your changes.

What type of PR is this?

Indicate the type of PR by adding one of the following options:

  • /kind fix
  • /kind bugfix
  • /kind enhancement
  • /kind feature
  • /kind feat
  • /kind change
  • /kind release-note-none

If this change should not appear in the changelog, use /kind release-note-none.

Example 1:

  ### What type of PR is this?
  /kind feature

Example 2:

  ### What type of PR is this?
  /kind release-note-none

Changelog Entry

Include a brief summary of your change for the changelog. This helps users understand what has been modified, added, or fixed in the project. If your change should not appear in the changelog, write NONE. Make sure to add only user-facing changes.

Example 1:

	### Changelog Entry
	```release-note
	api: Switch to POST for `LabelNames`.
	```

Example 2:

	### Changelog Entry
	```release-note
	NONE
	```