docs: add CHANGELOG.md and update contribution guidelines#174
Merged
komalharshita merged 1 commit intoMay 17, 2026
Merged
Conversation
|
@SamakhyaPathak is attempting to deploy a commit to the komalsony234-1530's projects Team on Vercel. A member of the Team first needs to authorize it. |
komalharshita
approved these changes
May 17, 2026
Owner
komalharshita
left a comment
There was a problem hiding this comment.
Thank you for the contribution. This is a clean and well-scoped documentation improvement.
Adding a structured CHANGELOG.md improves long-term project maintainability and contributor coordination, and the update to CONTRIBUTING.md aligns properly with the new documentation workflow.
I also appreciate that the PR follows an established changelog convention instead of introducing a custom structure.
The implementation is lightweight, consistent, and safe to merge.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary [required]
Added a new
CHANGELOG.mdfile to the repository root following the Keep a Changelog format for documenting notable project updates and future changes.Also updated
CONTRIBUTING.mdto remind contributors to update the changelog whenever they make user-facing or documentation-related changes.This improves documentation consistency and helps maintain a structured history of project updates for future contributors and maintainers.
Related Issue [required]
Closes #88
Type of Change [required]
What Was Changed [required]
CHANGELOG.mdCONTRIBUTING.mdCHANGELOG.mdfor relevant changesHow to Test This PR [required]
Clone this branch:
git checkout docs/add-changelogInstall dependencies:
pip install -r requirements.txtVerify that
CHANGELOG.mdexists in the repository root.Open
CHANGELOG.mdand confirm:Open
CONTRIBUTING.mdand verify the changelog reminder exists under:Before opening a PRRun the test suite:
python tests/test_basic.pyExpected test output:
Test Results [required]
PASS test_projects_json_loads
PASS test_each_project_has_required_fields
PASS test_find_project_by_id_found
PASS test_find_project_by_id_missing
PASS test_parse_skills_basic
PASS test_parse_skills_empty_string
PASS test_parse_skills_single_entry
PASS test_score_single_project_full_match
PASS test_score_single_project_no_match
PASS test_get_recommendations_returns_results
PASS test_get_recommendations_max_three
PASS test_get_recommendations_no_match_returns_empty
PASS test_get_recommendations_result_format
PASS test_validate_all_valid
PASS test_validate_missing_skills
PASS test_validate_missing_level
PASS test_validate_missing_interest
PASS test_validate_missing_time
PASS test_validate_all_missing
PASS test_home_route
PASS test_recommend_api_valid
PASS test_recommend_api_missing_field
PASS test_recommend_api_empty_body
PASS test_project_detail_found
PASS test_project_detail_not_found
PASS test_view_code_found
PASS test_download_code_found
27 passed, 0 failed out of 27 tests
Self-Review Checklist [required]
Notes for Reviewer
This PR only introduces documentation-related changes and does not modify application logic, tests, templates, routes, or UI behaviour.
The changelog entries were intentionally kept minimal and accurate to avoid adding undocumented or non-existent historical project changes.