-
Notifications
You must be signed in to change notification settings - Fork 7
docs: add changelog for project history and versioning #17
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
BekahHW
merged 3 commits into
OpenSource-Communities:main
from
abduelmorsi:docs/add-changelog
Oct 31, 2025
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't know we want this visible either. What do you think about moving it to the commented out point?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I believe it should be intented for maintaners as well, I'll work on it