|
| 1 | +# Changelog |
| 2 | + |
| 3 | +All notable changes to this project will be documented in this file. |
| 4 | + |
| 5 | +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), |
| 6 | +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 7 | + |
| 8 | +## [Unreleased] |
| 9 | + |
| 10 | +### Added |
| 11 | +- _Nothing yet_ |
| 12 | + |
| 13 | +### Changed |
| 14 | +- _Nothing yet_ |
| 15 | + |
| 16 | +### Deprecated |
| 17 | +- _Nothing yet_ |
| 18 | + |
| 19 | +### Removed |
| 20 | +- _Nothing yet_ |
| 21 | + |
| 22 | +### Fixed |
| 23 | +- _Nothing yet_ |
| 24 | + |
| 25 | +### Security |
| 26 | +- _Nothing yet_ |
| 27 | + |
| 28 | +## [1.0.0] - 2025-08-29 |
| 29 | + |
| 30 | +### Added |
| 31 | +- Initial release of RepoReady CLI |
| 32 | +- Repository evaluation functionality |
| 33 | +- Repository creation functionality |
| 34 | +- Support for GitHub personal access tokens |
| 35 | +- Comprehensive scoring system with 12 evaluation criteria |
| 36 | +- Organization-level community health file checking |
| 37 | +- Interactive CLI with `intro` and `examples` commands |
| 38 | +- Support for both npm installation and local development |
| 39 | + |
| 40 | +### Features |
| 41 | +- **Evaluate command**: Analyze any GitHub repository for contributor readiness |
| 42 | +- **Create command**: Set up new contributor-friendly GitHub repositories |
| 43 | +- **Scoring system**: 5-tier rating system (Excellent, Good, Fair, Needs Work, Not Ready) |
| 44 | +- **Actionable recommendations**: Specific suggestions for improvement |
| 45 | +- **Community health file detection**: Checks both repository and organization levels |
| 46 | + |
| 47 | +### Evaluation Criteria |
| 48 | +- Repository name and description |
| 49 | +- README file presence and quality |
| 50 | +- Contributing guidelines |
| 51 | +- Code of conduct |
| 52 | +- Open source license |
| 53 | +- Issue and PR templates |
| 54 | +- Good first issues and help wanted labels |
| 55 | +- Repository topics and activity status |
| 56 | + |
| 57 | +## How to Maintain This Changelog |
| 58 | + |
| 59 | +### For Contributors |
| 60 | +- Add entries to the "Unreleased" section when making changes |
| 61 | +- Use the appropriate category (Added, Changed, Fixed, etc.) |
| 62 | +- Write entries from the user's perspective |
| 63 | +- Reference issue numbers when applicable |
| 64 | + |
| 65 | +### For Maintainers |
| 66 | +- Move "Unreleased" items to a new version section when releasing |
| 67 | +- Add the release date |
| 68 | +- Update the comparison links at the bottom |
| 69 | +- Tag the release in Git with the version number |
| 70 | + |
| 71 | +### Categories |
| 72 | +- **Added** for new features |
| 73 | +- **Changed** for changes in existing functionality |
| 74 | +- **Deprecated** for soon-to-be removed features |
| 75 | +- **Removed** for now removed features |
| 76 | +- **Fixed** for any bug fixes |
| 77 | +- **Security** in case of vulnerabilities |
| 78 | + |
| 79 | +[unreleased]: https://github.com/OpenSource-Communities/RepoReady/compare/v1.0.0...HEAD |
| 80 | +[1.0.0]: https://github.com/OpenSource-Communities/RepoReady/releases/tag/v1.0.0 |
0 commit comments