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

Add RELEASE_PROCESS.md #63

Closed
5 tasks done
kreloaded opened this issue Aug 25, 2023 · 0 comments
Closed
5 tasks done

Add RELEASE_PROCESS.md #63

kreloaded opened this issue Aug 25, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@kreloaded
Copy link
Contributor

kreloaded commented Aug 25, 2023

In order to streamline our software release process and ensure consistency across our project versions, it's essential to document a clear and well-defined release process. This documentation will serve as a reference for all team members, contributors, and stakeholders involved in the release cycle. The addition of a release process markdown (MD) file will provide step-by-step guidance on how to prepare, package, and distribute new versions of our software.

Proposed Solution:
Create a new file named RELEASE_PROCESS.md in the root directory of our repository. This markdown file will outline the complete process that needs to be followed when preparing for a new release. The documentation should cover the following aspects:

  1. Versioning Scheme: Describe our approach to version numbers and how we determine whether a version change constitutes a major, minor, or patch release.

  2. Preparation Steps: Listing necessary pre-release checks, such as code reviews, test coverage thresholds, and CI/CD pipelines. Guidance on resolving outstanding issues or bugs before a release.

  3. Creating a Release Candidate: Steps to create a release branch or tag. Instructions for merging and testing changes specific to the upcoming release.

  4. Changelog Integration: How to update the CHANGELOG.md file with accurate and meaningful information about changes in the upcoming release.

  5. Packaging and Distribution: Instructions for packaging the release, creating binary artifacts, or publishing to package repositories. Steps to generate and upload documentation for the new release.

  6. Communication and Announcement: Guidance on announcing the release to relevant parties, such as users, stakeholders, and the wider community.

Benefits:

  • Consistency: A standardized release process reduces the chance of errors and oversights during each release.
  • Efficiency: Team members and contributors can follow a clear roadmap, saving time and effort.
  • Transparency: A well-documented process fosters transparency and allows others to understand our release strategy.
  • Collaboration: All team members, regardless of experience, can contribute to the release process with confidence.

Acceptance Criteria:

  • RELEASE_PROCESS.md file has been created in the root directory.
  • The documentation includes code snippets, examples, and best practices wherever relevant.
  • Team members have reviewed and provided feedback on the initial draft of the release process document.
  • Any necessary revisions based on feedback have been incorporated.
  • Implementing a release process markdown file will be a valuable addition to our repository, enabling us to manage our releases more efficiently and maintain a high level of quality and consistency across all versions. Let's collaborate to create this documentation and enhance our development practices.
@kreloaded kreloaded added the documentation Improvements or additions to documentation label Aug 25, 2023
@kreloaded kreloaded added this to the v0.2.0 milestone Aug 25, 2023
@kreloaded kreloaded self-assigned this Aug 25, 2023
@kreloaded kreloaded moved this to Ready in SalesSparrow Aug 25, 2023
@kreloaded kreloaded moved this from Ready to In Progress in SalesSparrow Aug 25, 2023
@kreloaded kreloaded moved this from In Progress to Done in SalesSparrow Aug 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

No branches or pull requests

1 participant