From 2e27d81e7e1aa1ff9fbbc893ef7c226b001b765c Mon Sep 17 00:00:00 2001 From: abduelmorsi Date: Sat, 18 Oct 2025 14:54:27 +0300 Subject: [PATCH 1/3] docs: add changelog for project history and versioning --- CHANGELOG.md | 80 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 4 +++ 2 files changed, 84 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..8e908df --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,80 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added +- _Nothing yet_ + +### Changed +- _Nothing yet_ + +### Deprecated +- _Nothing yet_ + +### Removed +- _Nothing yet_ + +### Fixed +- _Nothing yet_ + +### Security +- _Nothing yet_ + +## [1.0.0] - 2025-08-29 + +### Added +- Initial release of RepoReady CLI +- Repository evaluation functionality +- Repository creation functionality +- Support for GitHub personal access tokens +- Comprehensive scoring system with 12 evaluation criteria +- Organization-level community health file checking +- Interactive CLI with `intro` and `examples` commands +- Support for both npm installation and local development + +### Features +- **Evaluate command**: Analyze any GitHub repository for contributor readiness +- **Create command**: Set up new contributor-friendly GitHub repositories +- **Scoring system**: 5-tier rating system (Excellent, Good, Fair, Needs Work, Not Ready) +- **Actionable recommendations**: Specific suggestions for improvement +- **Community health file detection**: Checks both repository and organization levels + +### Evaluation Criteria +- Repository name and description +- README file presence and quality +- Contributing guidelines +- Code of conduct +- Open source license +- Issue and PR templates +- Good first issues and help wanted labels +- Repository topics and activity status + +## How to Maintain This Changelog + +### For Contributors +- Add entries to the "Unreleased" section when making changes +- Use the appropriate category (Added, Changed, Fixed, etc.) +- Write entries from the user's perspective +- Reference issue numbers when applicable + +### For Maintainers +- Move "Unreleased" items to a new version section when releasing +- Add the release date +- Update the comparison links at the bottom +- Tag the release in Git with the version number + +### Categories +- **Added** for new features +- **Changed** for changes in existing functionality +- **Deprecated** for soon-to-be removed features +- **Removed** for now removed features +- **Fixed** for any bug fixes +- **Security** in case of vulnerabilities + +[unreleased]: https://github.com/OpenSource-Communities/RepoReady/compare/v1.0.0...HEAD +[1.0.0]: https://github.com/OpenSource-Communities/RepoReady/releases/tag/v1.0.0 diff --git a/README.md b/README.md index 783f1a8..404466f 100644 --- a/README.md +++ b/README.md @@ -217,6 +217,10 @@ node dist/index.js evaluate your-org/your-repo - TypeScript knowledge (helpful for contributing) - All dependencies will be installed via `npm install` +## Changelog + +See [CHANGELOG.md](CHANGELOG.md) for a detailed history of changes. + ## Contributing This project follows the same best practices it evaluates! We welcome contributions and maintain: From 7134da6987ddbbbf927a3e29529950c8ec3582f2 Mon Sep 17 00:00:00 2001 From: Abdelrahman Elmorsi <153672541+abduelmorsi@users.noreply.github.com> Date: Mon, 20 Oct 2025 01:21:07 +0300 Subject: [PATCH 2/3] docs(changelog): add contributor instructions as hidden comment --- CHANGELOG.md | 50 ++++++++++++++++++++++++++------------------------ 1 file changed, 26 insertions(+), 24 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8e908df..f4c060f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,27 @@ + + # Changelog All notable changes to this project will be documented in this file. @@ -54,27 +78,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Good first issues and help wanted labels - Repository topics and activity status -## How to Maintain This Changelog - -### For Contributors -- Add entries to the "Unreleased" section when making changes -- Use the appropriate category (Added, Changed, Fixed, etc.) -- Write entries from the user's perspective -- Reference issue numbers when applicable - -### For Maintainers -- Move "Unreleased" items to a new version section when releasing -- Add the release date -- Update the comparison links at the bottom -- Tag the release in Git with the version number - -### Categories -- **Added** for new features -- **Changed** for changes in existing functionality -- **Deprecated** for soon-to-be removed features -- **Removed** for now removed features -- **Fixed** for any bug fixes -- **Security** in case of vulnerabilities - -[unreleased]: https://github.com/OpenSource-Communities/RepoReady/compare/v1.0.0...HEAD -[1.0.0]: https://github.com/OpenSource-Communities/RepoReady/releases/tag/v1.0.0 +[unreleased]: https://github.com/OpenSource-Communities/RepoReady/compare/v1.0.0...HEAD +[1.0.0]: https://github.com/OpenSource-Communities/RepoReady/releases/tag/v1.0.0 \ No newline at end of file From 98f850b65537375c20420ba970d884e7150d630b Mon Sep 17 00:00:00 2001 From: Abdelrahman Elmorsi <153672541+abduelmorsi@users.noreply.github.com> Date: Wed, 22 Oct 2025 16:25:49 +0300 Subject: [PATCH 3/3] chore: move Unreleased section and compare link into comment as template --- CHANGELOG.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f4c060f..3149399 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,9 @@ How to Maintain This Changelog - Add the release date. - Update the comparison links at the bottom. - Tag the release in Git with the version number. +- When preparing the next development cycle, recreate the [Unreleased] section + and add a new comparison link: + [unreleased]: https://github.com/OpenSource-Communities/RepoReady/compare/...HEAD ### Categories - **Added** for new features. @@ -20,14 +23,9 @@ How to Maintain This Changelog - **Removed** for now removed features. - **Fixed** for any bug fixes. - **Security** in case of vulnerabilities. ---> - -# Changelog - -All notable changes to this project will be documented in this file. -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +### Template for Adding a New Version +Use this block as an example when creating a new version section: ## [Unreleased] @@ -48,6 +46,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Security - _Nothing yet_ +--> + +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [1.0.0] - 2025-08-29 @@ -78,5 +84,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Good first issues and help wanted labels - Repository topics and activity status -[unreleased]: https://github.com/OpenSource-Communities/RepoReady/compare/v1.0.0...HEAD [1.0.0]: https://github.com/OpenSource-Communities/RepoReady/releases/tag/v1.0.0 \ No newline at end of file