diff --git a/development-guide.md b/CONTRIBUTING.md similarity index 88% rename from development-guide.md rename to CONTRIBUTING.md index 97eff37c4..100964b6a 100644 --- a/development-guide.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Promitor Development Guide +# Contributing to Promitor This guide explains the layout of the Promitor repository, along with the tools and technologies required to develop Promitor. @@ -33,6 +33,18 @@ to Promitor or modifying existing functionality, please add associated documenta Information about how to build and run the documentation locally can be found in the [README](docs/README.md) for the documentation. +Every PR will automatically build and deploy a preview version of the documentation for you. + +## Changelog + +All changes to Promitor are listed on [our changelog](https://changelog.promitor.io/) so that end-users can keep track + of changes per version over time. + +Every PR should document what has changed by adding an entry to our changelog located in `changelog\content\experimental\unreleased.md`. + +You can find some markup examples in `unreleased.md.template`, but every PR will automatically render a preview to make + it easier for you. + ## .NET Development Promitor is written in C# using .NET Core. To make changes to Promitor you need the diff --git a/README.md b/README.md index d89d4f113..4a8f746a0 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ welcome bug reports, improvement suggestions and pull requests. Want to see support for a scraper that is not [already supported](https://docs.promitor.io/configuration/v2.x/metrics/#supported-azure-services)? You can contribute by [adding one yourself](adding-a-new-scraper.md)! -Information about making changes to Promitor can be found [here](development-guide.md). +Information about making changes to Promitor can be found [here](contributing.md). ### Testing Infrastructure diff --git a/adding-a-new-scraper.md b/adding-a-new-scraper.md index e6f08e779..5c890434b 100644 --- a/adding-a-new-scraper.md +++ b/adding-a-new-scraper.md @@ -120,10 +120,16 @@ When the scraper supports resource discovery, the following documentation is req 2. Add scraper to supported scrapers on resource discovery configuration documentation page `docs/configuration/v2.x/resource-discovery.md` in alphabetical order. +## Changelog + +New scalers are a great additions and we should make sure that they are listed in our changelog. + +Learn about our changelog in our [contribution guide](CONTRIBUTING.md#Changelog). + ## See It In Action Now that you are done, make sure you run Promitor locally so verify that it generates the correct metrics! When opening the pull request (PR), feel free to copy the generated Prometheus metrics for review. -Learn how to run it in our [development guide](development-guide.md#running-promitor). +Learn how to run it in our [development guide](contributing.md#running-promitor).