-
Notifications
You must be signed in to change notification settings - Fork 2
Development Guidelines
Matthew Cochran edited this page Oct 10, 2024
·
1 revision
Coding Standards:
- Use TypeScript for type safety and clarity.
- Follow ESLint and Prettier configurations for consistent code formatting.
- Use meaningful variable and function names.
- Write JSDoc comments for complex functions.
Branching Strategy:
- Use the GitFlow workflow.
- Main branch for stable releases.
- Develop branch for ongoing development.
- Feature branches for new features (
feature/your-feature-name
). - Bugfix branches for fixes (
bugfix/issue-number-description
).
Commit Messages:
- Use clear and descriptive commit messages.
- Follow the convention:
Type(scope): Subject
- Types: feat, fix, docs, style, refactor, test, chore
- Scope: Optional, the part of the codebase affected.
- Subject: Brief description of the change.
Example:
feat(preprocessing): add new feature extraction method
- Home
- Getting Started
- Project Overview
- Directory Structure
- Detailed Documentation
- Development Guidelines
- Contributing
- FAQ
- References
- Acknowledgments
- Contact
Home • Getting Started • Project Overview • Contributing • FAQ
© 2023 HAR System Project. All rights reserved.