-
Fork & Clone
git clone https://github.com/your-username/nanofed.git cd nanofed
-
Set Up Environment
make install poetry shell
-
Create Feature Branch
git checkout -b feature/your-feature-name
<type>(<scope>): <description>
[optional body]
[optional footer(s)]
Type | Description |
---|---|
feat |
New features |
fix |
Bug fixes |
docs |
Documentation |
style |
Code style/formatting |
refactor |
Code refactoring |
perf |
Performance improvements |
test |
Adding/updating tests |
build |
Build system changes |
ci |
CI changes |
chore |
Maintenance tasks |
- Use imperative mood ("add" not "added")
- Don't capitalize first letter
- No period at the end
- Keep description under 72 characters
- Use body for "what" and "why"
- Update documentation
- Add unit or integration tests for new features
- Make sure all tests pass
- Target the
main
branch - 👀 Get at least one review
Follow the commit message convention:
feat(client): add new automatic feature