Browse Source

CONTRIBUTING.md updates, including changelog

pull/1252/head
Ross McFarland 7 months ago
parent
commit
748b390d4d
No known key found for this signature in database GPG Key ID: 943B179E15D3B22A
1 changed files with 4 additions and 1 deletions
  1. +4
    -1
      CONTRIBUTING.md

+ 4
- 1
CONTRIBUTING.md View File

@ -17,8 +17,11 @@ This project uses the [GitHub Flow](https://guides.github.com/introduction/flow/
0. Create a new branch: `git checkout -b my-branch-name`
0. Make your change, add tests, and make sure the tests still pass
0. Make sure that `./script/lint` passes without any warnings
0. Run `./script/format` to make sure your changes follow Python's preferred
coding style
0. Run `./script/changelog create ...` to add a changelog entry to your PR
0. Make sure that coverage is at :100:% `./script/coverage` and open `htmlcov/index.html`
* You can open PRs for :eyes: & discussion prior to this
* You can open a draft PR for :eyes: & discussion prior to this
0. Push to your fork and submit a pull request
We will handle updating the version, tagging the release, and releasing the gem. Please don't bump the version or otherwise attempt to take on these administrative internal tasks as part of your pull request.


Loading…
Cancel
Save