Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (38 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

50 lines (38 loc) · 1.18 KB

Contributing to Minisource Frontend Template

First off, thank you for considering contributing to this project!

Development Setup

  1. Fork the repository
  2. Clone your fork: 
    git clone https://github.com/YOUR_USERNAME/front-template.git
cd front-template
  3. Install dependencies: 
    npm install
  4. Create a branch for your feature: 
    git checkout -b feature/your-feature-name

Code Style

  • Use TypeScript for all new code
  • Follow the existing code style
  • Use Prettier for formatting (npm run format)
  • Ensure ESLint passes (npm run lint)
  • Write meaningful commit messages

Pull Request Process

  1. Ensure your code passes all tests: npm test
  2. Ensure there are no linting errors: npm run lint
  3. Ensure the build succeeds: npm run build
  4. Update documentation if needed
  5. Create a Pull Request with a clear description

Commit Messages

Use clear and descriptive commit messages:

  • feat: add new component
  • fix: resolve button hover state
  • docs: update README
  • refactor: simplify API client
  • test: add button component tests

Questions?

Feel free to open an issue for any questions or concerns.