Skip to content

Commit

Permalink
docs: ajoute des règles pour le changelog
Browse files Browse the repository at this point in the history
- Ajoute une nouvelle section "Change log" dans le fichier .cursorrules
- Spécifie le format et les conventions pour le CHANGELOG.md
- Ajoute des références à Keep a Changelog et Semantic Versioning
  • Loading branch information
raphaelgoetter committed Oct 14, 2024
1 parent 3b20644 commit 9ce40d9
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .cursorrules
Original file line number Diff line number Diff line change
Expand Up @@ -175,8 +175,27 @@ Special attention will be given to the accessibility of documents so that every
- Use the `chore` type for chores (e.g. updating dependencies, formatting files, etc.).
- A scope may be provided after a type. A scope must consist of a noun describing a section of the codebase surrounded by parenthesis, e.g., `fix(parser):`.

## Change log

- All notable changes to a project will be documented in a `CHANGELOG.md` file.
- The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
- There should be an entry for every single version.
- The same types of changes should be grouped.
- Versions and sections should be linkable.
- The latest version comes first.
- The release date of each version is displayed.
- Use these Types of changes:
- `Added` for new features.
- `Changed` for changes in existing functionality.
- `Deprecated` for soon-to-be removed features.
- `Removed` for now removed features.
- `Fixed` for any bug fixes.
- `Security` in case of vulnerabilities.

## References

- Refer to MDN Web Docs for HTML, JavaScript and CSS best practices.
- Refer to the RGAA guidelines for accessibility standards.
- Refer to Conventional Commits for commit messages.
- Refer to Keep a Changelog for change log.
- Refer to Semantic Versioning for versioning.

0 comments on commit 9ce40d9

Please sign in to comment.