docs: document all commit scopes

This commit is contained in:
Abdullah Atta
2022-08-31 16:17:45 +05:00
parent 9872da840d
commit 0e19d7638c

View File

@@ -105,9 +105,10 @@ All commits must include valid scopes in the commit message. **Valid commit scop
**Packages:** **Packages:**
1. `crypto`: changes related to the cryptographic core 1. `crypto`: changes related to the cryptographic core (including `@notesnook/crypto-worker`)
2. `editor`: changes related to the editor 2. `editor`: changes related to the editor (including `@notesnook/editor-mobile`)
3. `logger`: changes related to the logger 3. `logger`: changes related to the logger
4. `theme`: changes related to the theme
**Repo maintenance:** **Repo maintenance:**
@@ -115,6 +116,7 @@ All commits must include valid scopes in the commit message. **Valid commit scop
2. `ci`: changes related to CI 2. `ci`: changes related to CI
3. `setup`: setting up someting new in the repo (e.g. eslint, commitlint) 3. `setup`: setting up someting new in the repo (e.g. eslint, commitlint)
4. `docs`: changes related to documentation (README etc.) 4. `docs`: changes related to documentation (README etc.)
5. `refactor`: used for large scale refactoring (very rare)
**Some example commits would look like this:** **Some example commits would look like this:**