From 748b390d4d4b6a183fd2f060880b211607d446e1 Mon Sep 17 00:00:00 2001 From: Ross McFarland Date: Sat, 24 May 2025 16:08:14 -0700 Subject: [PATCH] CONTRIBUTING.md updates, including changelog --- CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6fed5bd..e26e8a1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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.