Before You Start
- Check open issues for existing discussions.
- For large changes, open an issue first to discuss.
Setup
- Fork the repository.
Clone your fork:
git clone https://git-service-hub.example.com/YOUR-USERNAME/REPO-NAME.git cd REPO-NAME
Set up upstream:
git remote add upstream https://git-service-hub.example.com/ORIGINAL-OWNER/REPO-NAME.git
Install dependencies:
composer install # or npm install, pip install -r requirements.txt, etc.
Development Workflow
Create a feature branch:
git checkout -b feat/your-feature-name
- Make your changes
Run tests:
composer test # npm test, pytest, make test, etc.
Commit changes:
git commit -m "feat: add new feature" # Use conventional commits if possible
Submitting Changes
Push to your fork:
git push origin feat/your-feature-name
- Open a Pull Request:
- Target the
main
branch on original owner's repo. - Use the PR template (if available).
- Describe changes clearly.
- Target the
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.