Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 1013 Bytes

CONTRIBUTING.md

File metadata and controls

66 lines (45 loc) · 1013 Bytes

How to contributing

Getting Started

  1. Fork the repository
  2. Create a new branch
  3. Make your changes
  4. Submit a pull request

Development Setup

  1. Install dependencies:
npm install
  1. Configure environment:
cp .env.example .env
  1. Build the project:
npm run build
  1. Run the project:
npm run start # or "npm run dev" if you prefer

Code Standards

  • Write clean, documented code
  • Follow TypeScript best practices
  • Update documentation as needed

Pull Request Process

  1. Update documentation
  2. Check if all works
  3. Submit PR with clear description

Bug Reports

When reporting bugs, include:

  • Node.js version
  • Framework version
  • Additional npm used
  • Full error message
  • Minimal code example

Feature Requests

When requesting features:

  • Explain the use case
  • Provide sample code, if applicable.
  • Describe the expected behavior and
  • Indicate if you can contribute your time
  • Indicate if you can help fund development