From 59e534dc59ad3bd7f63d9af528367d4c0e35f484 Mon Sep 17 00:00:00 2001 From: Sammy Harper <36314993+samharp@users.noreply.github.com> Date: Fri, 15 Dec 2023 12:47:14 -0600 Subject: [PATCH 1/2] fix(git): resolve typos within the commit message documentation page --- git/commit-message-naming.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/git/commit-message-naming.md b/git/commit-message-naming.md index c1871ef..b4c3f8c 100755 --- a/git/commit-message-naming.md +++ b/git/commit-message-naming.md @@ -30,7 +30,7 @@ Access right management is used to check proper authorization to access an API b ## Conventional Commits -Commit messages **MAY** use [Conventional Commits](https://www.conventionalcommits.org/en/) format. It provides guidelines to create a better commit history log, making easier to have automated tasks around it (e.g. automated changelogs). Commits would follow the format `[optional scope]: `, where `` might be `feat`/`fix`/`chore`/`docs` etc. and breaking changes are indicated on the beginning of the optional body or footer section. +Commit messages **MAY** use [Conventional Commits](https://www.conventionalcommits.org/en/) format. It provides guidelines to create a better commit history log, making it easier to have automated tasks around it (e.g. automated changelogs). Commits would follow the format `[optional scope]: `, where `` might be `feat`/`fix`/`chore`/`docs` etc. and breaking changes are indicated on the beginning of the optional body or footer section. Example: ``` @@ -39,4 +39,4 @@ git commit -m "feat(survey): add nps survey to the home page BREAKING CHANGE: `survey` objects in xml file have been re-used in the global configurations. ``` -Please refer to [Conventional Commits docs](https://www.conventionalcommits.org/en/) for more details +Please refer to [Conventional Commits docs](https://www.conventionalcommits.org/en/) for more details. From f852e34afa6b9b676f4a55612e1a3605a8d3bea7 Mon Sep 17 00:00:00 2001 From: Sammy Harper <36314993+samharp@users.noreply.github.com> Date: Fri, 15 Dec 2023 12:55:27 -0600 Subject: [PATCH 2/2] fix(git): resolve typos within the pull request documentation page 'Title' was displayed correctly in subheader, but as 'Subject' in page content (as per GitHub documentation, this should indeed be 'Title'; ref: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request#:~:text=Type%20a-,title,-and%20description%20for) --- git/pull-request-naming.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/git/pull-request-naming.md b/git/pull-request-naming.md index f7e3c2d..689859d 100755 --- a/git/pull-request-naming.md +++ b/git/pull-request-naming.md @@ -4,7 +4,7 @@ Consists of two parts: - Title: Short informative summary of the pull request - Description: More detailed explanatory text describing the PR for the reviewer -## Subject: +## Title: - Short and descriptive summary - Start with corresponding ticket/story id (e.g. from Jira, GitHub issue, etc.) - Should be capitalized and written in imperative present tense @@ -32,4 +32,4 @@ To achieve this, we needed to: - Find the best Gitbook plugin which can do the work - Integrate it in all the pages to redirect the user to the right page on GitHub for editing - Make it visible on the page so users can notice it easily -``` \ No newline at end of file +```