From 47f22579804d80963978db419d5bafda5da25ee8 Mon Sep 17 00:00:00 2001 From: Ted Summer Date: Wed, 7 Oct 2020 09:52:48 -0600 Subject: [PATCH 1/3] docs: add notes on git naming conventions --- docs/developer_resources.md | 38 +++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 docs/developer_resources.md diff --git a/docs/developer_resources.md b/docs/developer_resources.md new file mode 100644 index 00000000..58484725 --- /dev/null +++ b/docs/developer_resources.md @@ -0,0 +1,38 @@ +# Developer Resources + +## Git Naming Conventions + +Commit messages should follow the format of + + +```bash +[optional scope]: + +[optional body] +``` + +`type` must be one of the following: + +- **docs**: Changes to the documentation (e.g. improving the annotation of an element, updating this file, etc) +- **feat**: Adds a new feature (e.g. adding a new element to the schema) +- **fix**: A bug fix (e.g. adding a missing closing tag, or moving a misplaced element) +- **refactor**: Changes that don't fix a bug or add a new feature (e.g. turning an element into a complexType for reuse) +- **style**: Changes that don't affect the meaning of code (e.g. whitespace) +- **test**: Adding or correcting tests + +`scope` is optional, and should indicate the general area of the application affected. + +`description` is a short description of the changes in imperative present tense (such as “add function to _”, not “added function”) + +Branches should be named as `/`, where `scope` is the general scope affected, or if creating a feature branch, a shortened name of the feature being added. If `scope` is more than one word, it should be separated by dashes. + +Commit examples: + +- `feat(schema): add MyElement to ParentElement` +- `docs(proposals): add proposal for MyElement` +- `refactor: make SimpleElement restriction a regex test` + +Branch examples: + +- `feat/typical-operating-hours` +- `refactor/terminal-unit-type` From dddaf12ceae9f1953743bb7aec428a9ec25b7d68 Mon Sep 17 00:00:00 2001 From: Ted Summer Date: Wed, 7 Oct 2020 11:23:36 -0600 Subject: [PATCH 2/3] docs: add `proposal` as git commit type --- docs/developer_resources.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/developer_resources.md b/docs/developer_resources.md index 58484725..be293679 100644 --- a/docs/developer_resources.md +++ b/docs/developer_resources.md @@ -16,6 +16,7 @@ Commit messages should follow the format of - **docs**: Changes to the documentation (e.g. improving the annotation of an element, updating this file, etc) - **feat**: Adds a new feature (e.g. adding a new element to the schema) - **fix**: A bug fix (e.g. adding a missing closing tag, or moving a misplaced element) +- **proposal**: Adding or editing a proposal (e.g. creating a proposal for a new modeling concept for the schema) - **refactor**: Changes that don't fix a bug or add a new feature (e.g. turning an element into a complexType for reuse) - **style**: Changes that don't affect the meaning of code (e.g. whitespace) - **test**: Adding or correcting tests @@ -29,7 +30,7 @@ Branches should be named as `/`, where `scope` is the general scope Commit examples: - `feat(schema): add MyElement to ParentElement` -- `docs(proposals): add proposal for MyElement` +- `proposal: add proposal for MyElement` - `refactor: make SimpleElement restriction a regex test` Branch examples: From 132ca0ccb642bd7c3e1c307c1fd77a5292aadac0 Mon Sep 17 00:00:00 2001 From: Ted Summer Date: Tue, 13 Oct 2020 12:01:43 -0600 Subject: [PATCH 3/3] docs: add additional clarification of git conventions --- docs/developer_resources.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/developer_resources.md b/docs/developer_resources.md index be293679..7da8fa1a 100644 --- a/docs/developer_resources.md +++ b/docs/developer_resources.md @@ -6,7 +6,7 @@ Commit messages should follow the format of ```bash -[optional scope]: +[( optional scope )]: [optional body] ``` @@ -21,11 +21,13 @@ Commit messages should follow the format of - **style**: Changes that don't affect the meaning of code (e.g. whitespace) - **test**: Adding or correcting tests -`scope` is optional, and should indicate the general area of the application affected. +`scope` is optional for commit messages, and should indicate the general area of the application affected. `description` is a short description of the changes in imperative present tense (such as “add function to _”, not “added function”) -Branches should be named as `/`, where `scope` is the general scope affected, or if creating a feature branch, a shortened name of the feature being added. If `scope` is more than one word, it should be separated by dashes. +Branches should be named as `[optional issue number -]/`, where `scope` is the general scope affected, or if creating a feature branch, a shortened name of the feature being added. If `scope` is more than one word, it should be separated by dashes. + +Pull Request titles should follow the format `[# optional issue number] [( optional scope )]: `, following the same conventions as commit messages. Commit examples: @@ -35,5 +37,10 @@ Commit examples: Branch examples: -- `feat/typical-operating-hours` +- `1234-feat/typical-operating-hours` - `refactor/terminal-unit-type` + +Pull request examples: + +- `#1234 feat(schema): add MyElement to ParentElement` +- `proposal: add proposal for MyElement`