Skip to content

Commit

Permalink
doc: typo
Browse files Browse the repository at this point in the history
  • Loading branch information
bodinsamuel committed Sep 13, 2023
1 parent 1672e27 commit 4b8d574
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ A rule name should be:

## Add a new language / lockfile parser?

Easiest is to follow what others spec are doing. Here is the generic todo list.
Easiest is to follow what others spec are doing; here is the generic todo list.

- Go to folder `src/rules/spec/`
- Create your folder with the appropriate name
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,16 +260,16 @@ The exact types `AnalyserJson` can be found [here](./src/types/index.ts)

Every contribution is welcome. Check our [Contributing](./CONTRIBUTING.md) guide.

## Versionning
## Versioning

There is 2 things versioned in this package, the exposed API and the Data extraction.

The __API is following semver__:

- Breaking changes in the API will result in a new MAJOR.
- Anything will result in a MINOR `feat`, or a PATCH `fix`
- Anything else will result in a MINOR `feat`, or a PATCH `fix`

The __Data is following semver - MAJOR__:
The __Data is following semver without MAJOR__:

- Breaking changes in the Data will result in a new MINOR. A breaking change can be: removal of a tech, change in the tech category, removal of pattern for a tech, new data sources. `feat(rules)`
- Anything will result in a PATCH `fix(rules)`
- Anything else will result in a PATCH `fix(rules)`

0 comments on commit 4b8d574

Please sign in to comment.