Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (50 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

72 lines (50 loc) · 2.32 KB
Raw

Contributing to SignPakCommons

Thank you for your interest in contributing to SignPakCommons. This project exists to support Pakistan Sign Language data collection and accessibility work, and we value thoughtful, respectful contributions.

Ways to Contribute

You can help in several ways:

  • report bugs or usability issues
  • propose features or improvements
  • improve documentation
  • help with frontend or backend development
  • improve testing or QA coverage
  • contribute to data collection workflows and validation

Before You Start

  1. Read the project overview in README.md.
  2. Check the open issues and pull requests to avoid duplicating work.
  3. Start with a small, focused change if you are new to the project.
  4. Keep discussions respectful and grounded in the project mission and user impact.

Development Setup

Frontend

cd frontend
npm install
npm run dev

Backend

cd backend
npm install
npm run dev

For local backend work, create the environment configuration required by the app before starting the server, using the sample environment file or setup notes in the backend documentation.

Contribution Workflow

  1. Fork the repository and create a branch for your work.
  2. Make focused changes with clear commit messages.
  3. Run the relevant checks for the area you modified.
  4. Open a pull request with a clear description of the change and why it matters.
  5. Be responsive to review feedback and update the PR as needed.

Pull Request Guidelines

  • Keep changes small and easy to review.
  • Explain the problem being solved and the expected outcome.
  • Include screenshots or examples when the change affects user-facing behavior.
  • Update relevant documentation when the behavior or workflow changes.
  • Ensure the code follows the project's existing patterns and conventions.

Coding Standards

  • Write readable, maintainable code.
  • Prefer small, clear functions and simple logic.
  • Follow the repo's existing style and naming conventions.
  • Add or update tests when the change affects behavior.

Community Expectations

Please read and follow the project's CODE_OF_CONDUCT.md. We aim to make this a welcoming and productive environment for everyone.

Questions

If you are unsure where to start, open an issue and ask. We are happy to help guide new contributors.