diff --git a/docs/contributing/coding-guidelines.md b/docs/contributing/coding-guidelines.md index 9c71194..c01ebb5 100644 --- a/docs/contributing/coding-guidelines.md +++ b/docs/contributing/coding-guidelines.md @@ -24,7 +24,7 @@ - Test your code before committing -- +- ## Coding @@ -47,14 +47,14 @@ - most development should be the result of an issue -- Don't catch exceptions unless you expect to respond meaningfully. +- Don't catch exceptions unless you expect to respond meaningfully. - Configuration: config env vars should be high in the stack, adjacent to other configuration, and passed down. Env vars should typically not change behavior deep in a call stack. In no circumstance should an env var override an explicit setting higher in the stack. Debugging, logging, and other observability tooling are exceptions to this rule. -- +- ## Issues @@ -83,7 +83,7 @@ git tags in order to ensure that released software always corresponds to a git t - main is the release branch. - release-specific branches, branched off of main and named as x.y, support concurrent - patch release off the x.y + patch release off the x.y - dev is the development branch for integration testing. - feature development occurs in feature branches, branched off of dev and named for the corresponding issue (e.g., 42-bang-the-rocks-together). @@ -134,6 +134,4 @@ Tagging, releasing, changelogs ## Other -- We support most recent 3 Python releases; https://devguide.python.org/versions/ - - 3.9, 3.10, 3.11 now - - drop 3.9 and add 3.12 when 3.12 is available +- We support the three most recent [full Python releases](https://devguide.python.org/versions/): 3.10, 3.11, and 3.12