Skip to content

Conversation

@vilsonrodrigues
Copy link
Contributor

Summary

Adds comprehensive templates, improves documentation organization, and enhances repository automation.

Changes

  • Added CODEOWNERS - Automatic review assignment (@vilsonrodrigues)
  • Added Issue Templates - Bug report and feature request (YAML format)
  • Added PR Template - Comprehensive checklist for contributors
  • Added Pre-commit Config - Gitleaks (security), uv-lock sync, Ruff linting/formatting
  • Improved Release Drafter - Added breaking changes, refactoring, CI/CD categories
  • Created /docs Directory - Better organization for documentation
  • Moved Files to /docs - AUTOMATION.md and ROADMAP.md
  • Removed MERGE_BOT_GUIDE.md - Content integrated into AUTOMATION.md (English)
  • Updated AUTOMATION.md - Added /update command documentation
  • Moved Development Section - From README to CONTRIBUTING.md
  • Updated ROADMAP - Changed v0.2.0 to v1.1.0
  • Updated All References - Fixed links to moved documentation

Type of Change

  • Documentation update
  • CI/CD improvement
  • Chore/maintenance

Testing

  • Tests pass locally (uv run pytest -v)
  • Code formatted (uv run ruff format)
  • Lint checks pass (uv run ruff check)
  • Version NOT changed (maintainers bump version after merge)

Documentation

  • Updated README.md (removed Development section, added Contributing link)
  • Updated CONTRIBUTING.md (added Development section)
  • Added CODEOWNERS
  • Added issue templates
  • Added PR template
  • Updated all documentation references

Checklist

  • Code formatted
  • Lint checks pass
  • Tests pass
  • Version NOT changed
  • Commit messages follow conventional commits
  • No breaking changes
  • Documentation is up to date

Additional Notes

This PR significantly improves the contributor experience by:

  1. Templates make it easier for contributors to file good issues and PRs
  2. CODEOWNERS ensures automatic review assignment
  3. Pre-commit hooks catch issues before CI
  4. Better organization with /docs directory keeps root clean
  5. Improved Release Drafter provides better release notes categorization

Ready to use the new /merge command after CI passes! 🚀

…organization

- Add CODEOWNERS for automatic review assignment
- Add issue templates (bug report, feature request)
- Add pull request template with comprehensive checklist
- Add pre-commit config with gitleaks, uv-lock, and ruff
- Improve release-drafter.yml with more categories and better organization
- Move AUTOMATION.md and ROADMAP.md to docs/ directory
- Remove MERGE_BOT_GUIDE.md (content moved to AUTOMATION.md in English)
- Update AUTOMATION.md with /update command documentation
- Move Development section from README to CONTRIBUTING.md
- Update ROADMAP version from v0.2.0 to v1.1.0
- Update all documentation references to new file locations
@vilsonrodrigues vilsonrodrigues added documentation Improvements or additions to documentation chore Maintenance labels Nov 26, 2025
@github-actions github-actions bot added dependencies Dependency updates size/XL Extra large PR maintenance labels Nov 26, 2025
@vilsonrodrigues
Copy link
Contributor Author

/merge

@github-actions github-actions bot merged commit e3da14b into main Nov 26, 2025
10 checks passed
@github-actions
Copy link
Contributor

✅ PR merged successfully by @vilsonrodrigues!

@github-actions github-actions bot deleted the chore/improve-repo-structure branch November 26, 2025 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Maintenance dependencies Dependency updates documentation Improvements or additions to documentation maintenance size/XL Extra large PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants