Skip to content

Commit

Permalink
Add documentation requirements to various contrib assets (#608)
Browse files Browse the repository at this point in the history
* add documentation requirements

* final contrib updates

Co-authored-by: Juliano Costa <julianocosta89@outlook.com>
  • Loading branch information
cartersocha and julianocosta89 authored Nov 26, 2022
1 parent 126f0e8 commit 092e82d
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 7 deletions.
17 changes: 11 additions & 6 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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).
11 changes: 10 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,13 @@ Once the images are built and containers are started you can access:
- Feature Flags UI: <http://localhost:8080/feature/>
- Load Generator UI: <http://localhost:8080/loadgen//>

### 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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 092e82d

Please sign in to comment.