Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (45 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

64 lines (45 loc) · 1.38 KB

Contributing to SmartERP

Thank you for your interest in contributing to SmartERP!

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/smart-erp.git
  3. Install dependencies: npm install
  4. Create a branch: git checkout -b feature/your-feature

Development Workflow

1. Before Starting

2. Making Changes

  • Write tests first (TDD)
  • Follow code quality standards
  • Run linting: npm run lint
  • Run type checking: npm run type-check
  • Run tests: npm test

3. Commit Messages

Follow conventional commits:

feat: add user authentication
fix: resolve login bug
docs: update API documentation
test: add unit tests for auth service
refactor: improve user service performance

4. Pull Request Process

  • Ensure all tests pass
  • Update documentation
  • Request review from maintainers
  • Address review feedback

Code Quality Requirements

  • Test coverage ≥80%
  • No linting errors
  • No type errors
  • All tests passing
  • Documentation updated

Questions?

Open an issue or contact the maintainers.

Read more: