Skip to content

Commit

Permalink
feat(GH-8): Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gavanlamb committed Jun 15, 2024
1 parent 2f1a72f commit ebf7583
Showing 1 changed file with 43 additions and 4 deletions.
47 changes: 43 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ steps:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
### Multiple executions
### Multiple executions
```yaml
steps:
Expand All @@ -62,14 +62,53 @@ steps:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
## Changes
### Branching strategy
This repository uses [GitHub Flow](https://githubflow.github.io/) as the branching strategy.
TODO: update the
Branch names follow the format of `{type}/{ticket number}-{description}` the branch name is used to enrich the pull request description
Supported branch names are:
* `feature/*`
* `feat/*`
* `hotfix/*`
* `hf/*`
* `fix/*`
* `docs/*`
* `style/*`
* `refactor/*`
* `test/*`
* `chore/*`

### Commit messages
Commit messages for this repository follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.

Why is this approach used?

The intended release approaches

examples:

The versioning of this repository follows [Semantic Versioning](https://semver.org/) and the version is

### Versioning
Versioning is achieved using [GitVersion](https://gitversion.net/). The version is calculated based on the commits and the history of the repository.

Supported scenarios
* main
* hotfix
* feature
* pull request

Can be bumped or ignored based on commit messages. Look at `-version-bump-message` sections in https://gitversion.net/docs/reference/configuration.

### Release notes
Are generated from the generated version.

### Testing
#### Unit tests
Code coverage at branch 100%

#### Integration tests



The versioning of this repository follows [Semantic Versioning](https://semver.org/) and the version is

0 comments on commit ebf7583

Please sign in to comment.