Contributing

Before You Start

  1. Check open issues for existing discussions.
  2. For large changes, open an issue first to discuss.

Setup

  1. Fork the repository.
  2. Clone your fork:

    git clone https://git-service-hub.example.com/YOUR-USERNAME/REPO-NAME.git
    cd REPO-NAME
  3. Set up upstream:

    git remote add upstream https://git-service-hub.example.com/ORIGINAL-OWNER/REPO-NAME.git
  4. Install dependencies:

    composer install # or npm install, pip install -r requirements.txt, etc.

Development Workflow

  1. Create a feature branch:

    git checkout -b feat/your-feature-name
  2. Make your changes
  3. Run tests:

    composer test # npm test, pytest, make test, etc.
  4. Commit changes:

    git commit -m "feat: add new feature"  # Use conventional commits if possible

Submitting Changes

  1. Push to your fork:

    git push origin feat/your-feature-name
  2. Open a Pull Request:
    • Target the main branch on original owner's repo.
    • Use the PR template (if available).
    • Describe changes clearly.

Code Standards

  • Follow existing style (indentation, naming, etc.).
  • Include tests for new features.
  • Update relevant documentation.
  • Keep commits focused and atomic.

Need Help?

  • For contribution questions, comment on the issue.
  • For setup problems, check troubleshooting docs in the same project.

This project follows the following Code of Conduct.