mirror of
https://github.com/IRBorisov/ConceptPortal.git
synced 2025-06-26 04:50:36 +03:00
I: include commit convention
This commit is contained in:
parent
b7e6b24e44
commit
473f17cfa6
11
README.md
11
README.md
|
@ -11,13 +11,14 @@
|
|||
[](https://github.com/IRBorisov/ConceptPortal/actions/workflows/frontend.yml)
|
||||
|
||||
React + Django based web portal for editing RSForm schemas.
|
||||
This readme file is used mostly to document project dependencies
|
||||
This readme file is used mostly to document project dependencies and conventions.
|
||||
|
||||
## ❤️ Contributing notes
|
||||
|
||||
- feel free to open issues, discussion topics, contact maintainer directly
|
||||
- use Test config in VSCode to run tests before pushing commits / requests
|
||||
- use github actions to setup linter checks and test builds
|
||||
- use conventional commits to describe changes
|
||||
|
||||
## ✨ Frontend [Vite + React + Typescript]
|
||||
|
||||
|
@ -138,6 +139,14 @@ This readme file is used mostly to document project dependencies
|
|||
|
||||
# Developer Notes
|
||||
|
||||
## 📝 Commit conventions
|
||||
|
||||
- 🚀 F: major feature implementation
|
||||
- 💄 D: UI design
|
||||
- 🚑 B: bug fix
|
||||
- 🔧 R: refactoring and code improvement
|
||||
- 📝 I: documentation
|
||||
|
||||
## 🖥️ Local build (Windows 10+)
|
||||
|
||||
This is the build for local Development
|
||||
|
|
Loading…
Reference in New Issue
Block a user