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

Improve Krmx repository #20

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Improve Krmx repository #20

wants to merge 4 commits into from

Conversation

simonkarman
Copy link
Owner

This includes:

  • Add a license
  • Add contributing guidelines and a code of conduct
  • Create tags in git for published versions of the library
  • Create releases in GitHub

@simonkarman simonkarman requested a review from Copilot March 1, 2025 22:12
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Overview

This PR aims to improve the Krmx repository by adding essential documentation and automating version tagging for published releases.

  • Added CONTRIBUTING.md with detailed guidelines for contributors.
  • Introduced CODE_OF_CONDUCT.md to foster a positive community environment.
  • Updated GitHub workflows to automate tagging and version checks.
  • Revised README.md to direct contributors to the new guidelines and code of conduct.

Reviewed Changes

File Description
CONTRIBUTING.md Added comprehensive contribution guidelines with minor typos.
CODE_OF_CONDUCT.md Introduced a detailed code of conduct based on Contributor Covenant.
.github/workflows/publish.yml Improved the publishing workflow with automated tag creation.
README.md Updated sections to reference new contributing guides and license info.
.github/workflows/version.yml Simplified version checking by using an external script.
features.md Clarified starter application instructions with a direct link.

Copilot reviewed 28 out of 28 changed files in this pull request and generated 2 comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant