Thank you for your interest in contributing! All tools in the DevForge organization are open source (MIT) and built with contribution in mind.
- Check existing issues for something you'd like to work on.
- If you're fixing a bug or adding a feature, open an issue first to discuss.
- Fork the repository and create a branch named
yourname/short-description. - We recommend prefixing with your GitHub username, e.g.
alice/fix-readme-typo.
- Follow the existing code style (we use
rufffor Python formatting). - Keep commits small and focused.
- Use Conventional Commits:
type(scope): descriptionExamples:fix(cli): handle empty input gracefully,docs(readme): update install instructions
- Run the full test suite before submitting:
pytestorhatch run test - If adding new functionality, include tests.
- Ensure lint passes:
ruff check .(orhatch run lint)
- Open a PR against the
mainbranch. - Fill out the PR template (checklist, description, etc.).
- CI will run automatically. All checks must pass before merging.
- A maintainer (AI or human) will review your PR.
- Address any feedback and update as needed.
- Once approved, your PR will be squashed and merged.
# Clone the repo
git clone https://github.com/Coding-Dev-Tools/<repo-name>.git
cd <repo-name>
# Install dev dependencies
pip install -e ".[dev]"
# or
hatch env create
# Run tests
pytestBe respectful and constructive. This is a community of developers helping developers.
Open a Discussion or reach out on Twitter.