Problem
Our repository currently lacks a structured release process and clear guidelines for community contributions. This leads to unpredictable versioning in our CI/CD pipeline and messy, unorganised feedback in our issues backlog.
Proposed Changes
- CI/CD Automation: Implement Semantic Versioning (Major.Minor.Patch) using tools like
semantic-release or GitHub Actions to automate version bumping based on conventional commits.
- GitHub Issue Templates: Create a
.github/ISSUE_TEMPLATE/ directory containing standardized markdown templates for Feature Requests, Bug Reports, and Maintenance Task logs to enforce structured user feedback.
Check all other packages including omop-graph and omop-emb for inspiration. Would allow us to also have a common structure for the CI/CD.
NOTE: Not necessarily here but maybe we could think about the option to bundle PRs in the main branch and then eventually only do a new release manually. That would require some work in the CI/CD and also of us during PRs and fixes etc. so the messages are nicely in the changelog.
See torchio for an example.
Problem
Our repository currently lacks a structured release process and clear guidelines for community contributions. This leads to unpredictable versioning in our CI/CD pipeline and messy, unorganised feedback in our issues backlog.
Proposed Changes
semantic-releaseor GitHub Actions to automate version bumping based on conventional commits..github/ISSUE_TEMPLATE/directory containing standardized markdown templates for Feature Requests, Bug Reports, and Maintenance Task logs to enforce structured user feedback.Check all other packages including
omop-graphandomop-embfor inspiration. Would allow us to also have a common structure for the CI/CD.NOTE: Not necessarily here but maybe we could think about the option to bundle PRs in the main branch and then eventually only do a new release manually. That would require some work in the CI/CD and also of us during PRs and fixes etc. so the messages are nicely in the changelog.
See torchio for an example.