Skip to content

Commit

Permalink
docs: add versioning information to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RomanFama592 committed Feb 8, 2024
1 parent f02342f commit 9a37f30
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,20 @@ If you have a suggestion that would make this better, please fork the repo and c
> [!IMPORTANT]
> Use [`conventional commits`](https://www.conventionalcommits.org/) and ensure that the code passes the linter test, pull requests are not accepted without this last point.
Keep in mind that every change to the website would require updating the version in the `package.json`.

### versioning of the page

- `format of verisoned`
- `MAYOR`.`MINOR`.`PATCH`

### most relevant types of changes that affect versioning
- `minor-feat`: Only used for making minor changes to existing things. update a `PATCH` version.
- `fix`: Used when fixing a bug. update a `PATCH` version.
- `feat`: Used when adding substantial content anywhere on the page. update a `MINOR` version.

- The `MAJOR` version is only incremented when the `MINOR` version reaches 100 or there is a deep and general change across the entire page. This would only be handled by me, the repository owner.

1. Fork the project.

2. Clone your fork.
Expand Down

0 comments on commit 9a37f30

Please sign in to comment.