mirror of
https://github.com/priyanshujain/margin.git
synced 2026-10-02 19:17:03 +00:00
17 lines
832 B
Markdown
17 lines
832 B
Markdown
## Project Guidelines
|
|
|
|
- Do not call the task done until it is fully complete and tested.
|
|
- Do not dismiss bug as a pre-existing" issue even if it was present before your change. It does not matter, it's still your responsibility to fix it. When you see a bug, fix it. Don't ignore it.
|
|
|
|
## Coding Guidelines
|
|
|
|
- Keep code simple and easy to read.
|
|
- Avoid excessive comments. Only comment when absolutely necessary. Code should be readable and not require comments to understand it.
|
|
|
|
## Git Commit Rules
|
|
|
|
- Use conventional commit format: `feat|fix|refactor|docs|test|chore|ci(scope): message`
|
|
- Never use `git add .` or `git add -A`. Always stage specific files by name.
|
|
- Don't batch multiple unrelated changes into one commit.
|
|
- Commit early and often. A working 5-line change is better than a pending 200-line change.
|