From a4d97b70981f8576e220be4d57fa2ea3b1f25650 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matheus=20Vila=C3=A7a=20de=20Jesus?= Date: Fri, 31 Oct 2025 22:31:09 -0300 Subject: [PATCH] docs: add CODEOWNERS and CONTRIBUTING guide - Add CODEOWNERS file for automatic review requests - Add CONTRIBUTING.md with development guidelines - Document commit conventions and PR process --- .github/CODEOWNERS | 12 +++++++++ CONTRIBUTING.md | 66 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 78 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 CONTRIBUTING.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..1712323 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,12 @@ +# Code owners for Q Commit extension +# These owners will be automatically requested for review when someone opens a pull request + +# Default owners for everything in the repo +* @codeatlasdev + +# Specific owners for workflows and CI/CD +/.github/ @codeatlasdev + +# Package and dependencies +/package.json @codeatlasdev +/package-lock.json @codeatlasdev diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..08c9a1a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,66 @@ +# Contributing to Q Commit + +Thank you for your interest in contributing! 🎉 + +## Development Setup + +1. Fork and clone the repository +2. Install dependencies: + ```bash + npm install + ``` +3. Start development mode: + ```bash + npm run watch + ``` + +## Making Changes + +1. Create a new branch: + ```bash + git checkout -b feat/your-feature + ``` + +2. Make your changes + +3. The pre-commit hook will automatically: + - Run ESLint and fix issues + - Format code with Prettier + - Run type checking + +4. Commit your changes: + ```bash + git commit -m "feat: your feature description" + ``` + +## Commit Convention + +We follow [Conventional Commits](https://www.conventionalcommits.org/): + +- `feat:` - New feature +- `fix:` - Bug fix +- `docs:` - Documentation changes +- `chore:` - Maintenance tasks +- `refactor:` - Code refactoring +- `test:` - Adding tests + +## Pull Request Process + +1. Push your branch to your fork +2. Open a Pull Request against `main` +3. Fill out the PR template +4. Wait for CI checks to pass +5. Request review from maintainers +6. Address any feedback + +## Code Quality + +All PRs must: +- ✅ Pass ESLint checks +- ✅ Pass TypeScript type checking +- ✅ Pass CI build +- ✅ Be approved by at least one maintainer + +## Questions? + +Open an issue or reach out to the maintainers!