From fa79c5b710c5da33ba91a827a58bd342cb146d7b Mon Sep 17 00:00:00 2001 From: Your Name Date: Sat, 13 Jul 2024 17:10:58 +0200 Subject: [PATCH] docs: upgraded CONTRIBUTING.md instructions --- CONTRIBUTING.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d0114bb1f..cb64fde9d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,4 +15,20 @@ The base version represents the MAJOR and MINOR parts of [SemVer](https://semver ## Commits and PR title -- Please use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) to name your commits and PR title \ No newline at end of file +- Please use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) to name your commits and PR title + Available types: + - feat: A new feature + - fix: A bug fix + - docs: Documentation only changes + - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) + - refactor: A code change that neither fixes a bug nor adds a feature + - perf: A code change that improves performance + - test: Adding missing tests or correcting existing tests + - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) + - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) + - chore: Other changes that don't modify src or test files + - revert: Reverts a previous commit +- Examples: + - fix: Resolved mock file system not able to return mock data + - docs: Added more details to readme.md and examples + - feat: Added a new MockFileStream features for more robust unit testing experience