diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fc1f9dcc..a3736adb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/README.md b/README.md index 282f791f..151d0f29 100644 --- a/README.md +++ b/README.md @@ -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)`