Skip to content

Commit 74c980a

Browse files
authored
update contributing.md (#43)
since `make docs_clean` bloats incoming PRs with 300+ changes, going to do this before each release instead.
1 parent 6cfcebd commit 74c980a

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,8 @@ The repo uses GitHub workflows to publish a draft release when a new tag is
7171
pushed. We use [semver](https://semver.org/#summary) to determine the version
7272
number for the tag.
7373

74+
0. Run `make docs_clean` and then `make generate-docs` to remove any unnecessary documentation. Automatic PRs from OpenAPI 3.0 changes will run `make generate-docs` but not `make docs_clean`. Create a PR and merge these changes.
75+
7476
1. Run `make changes` to review the merged PRs since last release and decide what kind of release you are doing (bugfix, feature or breaking).
7577
* Review the tags on each PR and make sure they are categorized
7678
appropriately.

0 commit comments

Comments
 (0)