Skip to content

contribute.md

Latest commit

 

History

History
60 lines (41 loc) · 1.23 KB

contribute.md

File metadata and controls

60 lines (41 loc) · 1.23 KB

Contributing to Sanghathi Backend

Thank you for contributing to Sanghathi Backend.

Contribution Workflow

  1. Fork the repository on GitHub.
  2. Clone your fork locally.
git clone https://github.com/YOUR-USERNAME/Sanghathi-Backend.git
cd Sanghathi-Backend
git remote add upstream https://github.com/Sanghathi/sanghathi-Backend.git
  1. Install dependencies.
npm install
  1. Create a feature branch.
git checkout -b feature/your-feature-name
  1. Run the backend and implement your changes.
npm run dev

  1. Validate your API changes before opening PR using Postman or Insomnia.

  2. Commit with a clear message.

git commit -m "feat: short description of change"
  1. Push and open a Pull Request to main.
git push origin feature/your-feature-name

Pull Request Checklist

  • Backend starts and runs without errors.
  • Input validation and error handling are preserved.
  • API changes are documented.
  • No unnecessary logs or dead code.
  • PR description clearly explains API and model changes.

Need Help or Have Doubts?

  1. Open an issue with title prefix Question:.
  2. Add endpoint details, payload, and error response.
  3. Include reproduction steps and expected output.