From 092e82dbaaf64402ec80c8b5ad75b0e5607c98d8 Mon Sep 17 00:00:00 2001 From: Carter Socha <43380952+cartersocha@users.noreply.github.com> Date: Sat, 26 Nov 2022 08:22:50 -0600 Subject: [PATCH] Add documentation requirements to various contrib assets (#608) * add documentation requirements * final contrib updates Co-authored-by: Juliano Costa --- .github/PULL_REQUEST_TEMPLATE.md | 17 +++++++++++------ CONTRIBUTING.md | 11 ++++++++++- 2 files changed, 21 insertions(+), 7 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b5fc738afc..def22c7e56 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,10 +1,15 @@ -Fixes #. - -## Changes +# Changes Please provide a brief description of the changes here. -For significant contributions please make sure you have completed the following items: +## Merge Requirements + +For new features contributions please make sure you have completed the following +essential items: + +* [ ] `CHANGELOG.md` updated to document new feature additions +* [ ] Appropriate documentation updates in the [docs](../docs/) folder -* [ ] Appropriate `CHANGELOG.md` updated for non-trivial changes -* [ ] Design discussion issue # +Maintainers will not merge until the above have been completed. If you're unsure +which docs need to be changed ping the +[@open-telemetry/demo-approvers](https://github.com/orgs/open-telemetry/teams/demo-approvers). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 431856d08f..7443e677d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -97,6 +97,13 @@ Once the images are built and containers are started you can access: - Feature Flags UI: - Load Generator UI: +### Review the Documentation + +The Demo team is committed to keeping the demo up to date. That means the +documentation as well as the code. When making changes to any service or feature +remember to find the related docs and update those as well. Most (but not all) +documentation can be found the [docs](./docs/) folder. + ## Create Your First Pull Request ### How to Send Pull Requests @@ -165,7 +172,9 @@ A PR is considered to be **ready to merge** when: - Major feedbacks are resolved. - It has been open for review for at least one working day. This gives people reasonable time to review. -- Trivial change (typo, cosmetic, doc, etc.) doesn't have to wait for one day. +- The [documentation](./docs/) and [Changelog](./CHANGELOG.md) have been updated + to reflect the new changes. +- Trivial changes (typo, cosmetic, doc, etc.) don't have to wait for one day. Any Maintainer can merge the PR once it is **ready to merge**. Note, that some PRs may not be merged immediately if the repo is in the process of a release and