Skip to content

Commit

Permalink
docs: update CONTRIB guidlines
Browse files Browse the repository at this point in the history 
This commit adds more specific content around the expectation of use of
conventional commits and Auro.

Changes to be committed:
modified:   .github/CONTRIBUTING.md
modified:   template/.github/CONTRIBUTING.md
  • Loading branch information
@blackfalcon
blackfalcon committed Mar 7, 2024
1 parent 58128a5 commit 6021ace
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 8 deletions.
30 changes: 26 additions & 4 deletions .github/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,31 +77,53 @@ This project utilizes [Conventional Commits](https://www.conventionalcommits.org

**NOTE:** Before working in your project, be sure to run `$ npm i` to ensure that all packages are installed.

Submitting pull requests that do not conform to the Conventional Commits standard, the team will assume that development dependencies were not installed and no tests were validated prior to submission. **This may result in immediate disqualification of the pull request**.
#### Commit Message Format

Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**:

```html
<type>[optional scope]: <description>
<type>(<scope>): <subject> <!-- header -->
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
```

**Any line of the commit message cannot be longer 100 characters!** This allows the message to be easier to read on GitHub as well as in various git tools. The **header** MUST use an **imperative mood**. The **body**, freeform text is allowed. Please see the **Git commit messages** section below.

The header is mandatory and the scope of the header is optional. Please see this [example commit](https://github.com/AlaskaAirlines/WC-Generator/commit/8e24c16461ca71349c8986da2a2f33b88426e015) from the WC-Generator repo.

Submitting pull requests that do not conform to the Conventional Commits standard, the team will assume that development dependencies were not installed and no tests were validated prior to submission. **This may result in immediate disqualification of the pull request**.

#### Prefixes

**All commit messages** must be prefixed with a specific type so that the semver release configuration can analyze the commit and apply the correct version release. Please see the following types with their respective meanings.

#### MAJOR

For a MAJOR release, you MUST follow this template. The use `BREAKING CHANGE:` in conjunction with any other commit type is required in order to push a major release.
For a **MAJOR** release, you **MUST** follow this template. The use `BREAKING CHANGE:` in conjunction with any other commit type is required in order to push a major release.

A `BREAKING CHANGE` body message can be appended to any prefix that is descriptive of the change.

```
perf(pencil): remove graphiteWidth option #80
refactor(pencil): remove graphiteWidth option #80
BREAKING CHANGE: The graphiteWidth option has been removed.
The default graphite width of 10mm is always used for performance reasons.
```

#### MINOR

Using the `feat` prefix will result in a `0.1.0` SemVer release update.

```
feat(pencil): add 'graphiteWidth' option #80
```

#### PATCH

Using the `fix` or `perf` prefix will result in a `0.0.1` SemVer release update.

```
fix(pencil): stop graphite breaking when too much pressure applied #80
```
Expand Down
30 changes: 26 additions & 4 deletions template/.github/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,31 +77,53 @@ This project utilizes [Conventional Commits](https://www.conventionalcommits.org

**NOTE:** Before working in your project, be sure to run `$ npm i` to ensure that all packages are installed.

Submitting pull requests that do not conform to the Conventional Commits standard, the team will assume that development dependencies were not installed and no tests were validated prior to submission. **This may result in immediate disqualification of the pull request**.
#### Commit Message Format

Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**:

```html
<type>[optional scope]: <description>
<type>(<scope>): <subject> <!-- header -->
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
```

**Any line of the commit message cannot be longer 100 characters!** This allows the message to be easier to read on GitHub as well as in various git tools. The **header** MUST use an **imperative mood**. The **body**, freeform text is allowed. Please see the **Git commit messages** section below.

The header is mandatory and the scope of the header is optional. Please see this [example commit](https://github.com/AlaskaAirlines/WC-Generator/commit/8e24c16461ca71349c8986da2a2f33b88426e015) from the WC-Generator repo.

Submitting pull requests that do not conform to the Conventional Commits standard, the team will assume that development dependencies were not installed and no tests were validated prior to submission. **This may result in immediate disqualification of the pull request**.

#### Prefixes

**All commit messages** must be prefixed with a specific type so that the semver release configuration can analyze the commit and apply the correct version release. Please see the following types with their respective meanings.

#### MAJOR

For a MAJOR release, you MUST follow this template. The use `BREAKING CHANGE:` in conjunction with any other commit type is required in order to push a major release.
For a **MAJOR** release, you **MUST** follow this template. The use `BREAKING CHANGE:` in conjunction with any other commit type is required in order to push a major release.

A `BREAKING CHANGE` body message can be appended to any prefix that is descriptive of the change.

```
perf(pencil): remove graphiteWidth option #80
refactor(pencil): remove graphiteWidth option #80
BREAKING CHANGE: The graphiteWidth option has been removed.
The default graphite width of 10mm is always used for performance reasons.
```

#### MINOR

Using the `feat` prefix will result in a `0.1.0` SemVer release update.

```
feat(pencil): add 'graphiteWidth' option #80
```

#### PATCH

Using the `fix` or `perf` prefix will result in a `0.0.1` SemVer release update.

```
fix(pencil): stop graphite breaking when too much pressure applied #80
```
Expand Down

0 comments on commit 6021ace

Please sign in to comment.