Skip to content

Fix typos in Git naming convention pages #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix typos in Git naming convention pages #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59e534d
fix(git): resolve typos within the commit message documentation page
samharp Dec 15, 2023
f852e34
fix(git): resolve typos within the pull request documentation page
samharp Dec 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions git/commit-message-naming.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<type>[optional scope]: <description>`, where `<type>` 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 `<type>[optional scope]: <description>`, where `<type>` might be `feat`/`fix`/`chore`/`docs` etc. and breaking changes are indicated on the beginning of the optional body or footer section.

Example:
```
Expand All @@ -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.
4 changes: 2 additions & 2 deletions git/pull-request-naming.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
```
```