mfogliatto/ReferenceCop

Introduce CHANGELOG.md file

Open

#27 opened on May 10, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)C# (2 forks)auto 404
choregood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (PR metrics pending)

Description

Description

We need to introduce a CHANGELOG.md file to track changes between versions and provide users with clear information about updates, new features, and bug fixes.

Problem

Without a proper changelog, it's difficult for users and contributors to understand what has changed between versions, which features have been added, and which bugs have been fixed.

Proposed Solution

  1. Create a CHANGELOG.md file in the root of the repository
  2. Document changes for previous releases (if feasible)
  3. Establish a process for updating the changelog with new releases

Implementation Details

  • Use the Keep a Changelog format
  • Include sections for Added, Changed, Deprecated, Removed, Fixed, and Security
  • Link to GitHub issues and pull requests where appropriate
  • Maintain the changelog for all future releases

Acceptance Criteria

  • CHANGELOG.md file exists in the repository root
  • Format is clear, consistent, and follows established practices
  • Recent changes are documented with appropriate details
  • Process is in place for maintaining the changelog with future releases

Contributor guide

Research direction
Check if a CHANGELOG.md already exists at the repository root, review recent commits and release tags to gather details, then create the file using the Keep a Changelog format with sections for Added, Changed, Deprecated, Removed, Fixed, and Security.
Tech stack
csharp
Domain
backendtooling
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90