From 974fef8c63ff7c3784876e9ead14feaef66a0777 Mon Sep 17 00:00:00 2001 From: "Matthew X. Economou" Date: Sat, 7 Sep 2024 10:16:35 -0400 Subject: [PATCH] style: adopt the Google Markdown style guide --- CONTRIBUTING.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1d1c9ee..e37bf42 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,13 @@ # Contributing -This project uses the [Git feature branch workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow). Please submit your changes for review as a [GitHub pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests). +This project combines [test-driven development](https://tdd.mooc.fi/), +[atomic commits](https://www.aleksandrhovhannisyan.com/blog/atomic-git-commits/), +a [linear commit history](https://archive.is/VpWTs), and the +[Git feature branch workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow). +Please rebase your changes on the latest HEAD of the main branch +before submitting them for review as a +[GitHub pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests). +Changes must include updated functional and integration tests. ## Development Environment @@ -48,9 +55,14 @@ The following code styles are in use: - [Python Black](https://black.readthedocs.io/) and [isort](https://pycqa.github.io/isort/) +- [the Home Assistant YAML style guide](https://developers.home-assistant.io/docs/documenting/yaml-style-guide/) + +- [the Google Markdown style guide](https://google.github.io/styleguide/docguide/style.html), + but with a more traditional 70-character line limit + - [Dockerfile best practices](https://docs.docker.com/develop/develop-images/dockerfile_best-practices/) -- [the Home Assistant YAML style guide](https://developers.home-assistant.io/docs/documenting/yaml-style-guide/) +- [AWS CloudFormation best practices](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/best-practices.html) ## Commit Messages