Skip to content

docs: add Releasing and Contributing#139

Merged
TheRealAgentK merged 4 commits intomasterfrom
docs/releasing-contributing
Apr 1, 2025
Merged

docs: add Releasing and Contributing#139
TheRealAgentK merged 4 commits intomasterfrom
docs/releasing-contributing

Conversation

@miquelbeltran
Copy link
Contributor

docs: add Releasing and Contributing

Description 📝

  • Purpose: Adds releasing and contributing documents
  • Approach: Following the same template as Raygun4Flutter

Type of change

  • Docs

Updates

  • Created documents.
  • Removed section from README.md as it was moved to the Contributing doc.

Author to check 👓

  • Project and all contained modules builds successfully
  • Self-/dev-tested
  • Unit/UI/Automation/Integration tests provided where applicable
  • Code is written to standards
  • Appropriate documentation written (code comments, internal docs)

Reviewer to check ✔️

  • Project and all contained modules builds successfully
  • Change has been dev-/reviewer-tested, where possible
  • Unit/UI/Automation/Integration tests provided where applicable
  • Code is written to standards
  • Appropriate documentation written (code comments, internal docs)

@sumitramanga
Copy link
Collaborator

Is this ready for review @miquelbeltran

@miquelbeltran
Copy link
Contributor Author

Yep! sorry I forgot about this one

Copy link
Contributor

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.

Pull Request Overview

This PR introduces two new documentation files to support the project's release process and contributor onboarding.

  • Added RELEASING.md with guidelines for versioning, preparing for release, and publishing.
  • Added CONTRIBUTING.md detailing project organization, development practices, and contribution guidelines.

Reviewed Changes

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

File Description
RELEASING.md Instructions for semantic versioning and release procedures.
CONTRIBUTING.md Guidelines for contributing, including project organization and testing commands.

miquelbeltran and others added 2 commits March 27, 2025 22:53
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@sumitramanga
Copy link
Collaborator

@miquelbeltran did you trigger that copiolet review? 🤔

Co-authored-by: Sumitra Manga <36393794+sumitramanga@users.noreply.github.com>
@miquelbeltran
Copy link
Contributor Author

@miquelbeltran did you trigger that copiolet review? 🤔

I did! First time trying it.

@TheRealAgentK TheRealAgentK merged commit d3f1039 into master Apr 1, 2025
8 checks passed
@sumitramanga sumitramanga deleted the docs/releasing-contributing branch May 2, 2025 01:07
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.

4 participants