Skip to content
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

Publish Changelog #106

Open
3 tasks
azriel1rf opened this issue May 7, 2024 · 0 comments
Open
3 tasks

Publish Changelog #106

azriel1rf opened this issue May 7, 2024 · 0 comments

Comments

@azriel1rf
Copy link
Collaborator

The project currently lacks a formally published changelog. A well-maintained changelog is essential for users and contributors to track changes, updates, and fixes over time.

Task

  • Create a changelog that documents the historical and upcoming changes in a clear and structured format.
  • Publish the changelog in a suitable section of the project repository, such as under a CHANGELOG.md file or a dedicated section in the documentation.

Optional Task

  • Once the changelog is published, consider updating the Changelog field in the [project.urls] section of pyproject.toml to link directly to the changelog. Current placeholder URL is https://github.com/HenryRLee/PokerHandEvaluator/tags.

Relevant Files

  • Potentially new CHANGELOG.md or updates to existing documentation files.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant