Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 1.59 KB

File metadata and controls

42 lines (31 loc) · 1.59 KB

Contributing to Tech Quests projects

Contributions are welcome — issues, fixes, ideas, or full features. To keep things smooth, a few quick guidelines.

Before you start

  1. Check the issue tracker of the repo you want to contribute to. Someone may already be working on the same thing.
  2. Open an issue first for non-trivial changes. A short discussion saves time on both sides — better to align on approach before writing code.
  3. For typos and small fixes, just open a PR directly.

Submitting changes

  1. Fork the repo and create a topic branch from main (or the default branch).
  2. Follow existing patterns. Match the codebase's style, naming, and structure rather than introducing new ones.
  3. Add tests for new behavior. Don't lower coverage. Run the test suite and lint before submitting.
  4. Keep PRs focused. One concern per PR; smaller PRs land faster.
  5. Write a clear PR description. What changed, why, and how to verify it.

Style conventions

  • Commit messages: Conventional Commits (feat:, fix:, docs:, chore:, refactor:, test:, ci:).
  • Code style: whatever the repo already uses (linter config + formatter in CI). Don't reformat unrelated lines.
  • Documentation: update the README and any relevant docs in the same PR as the code change.

Code of conduct

By participating you agree to follow the Code of Conduct.

Questions

Open a GitHub Discussion (if enabled on the repo) or email contact@techquests.dev.