Thanks for contributing to this project! 👍 This project and everyone participating in it is governed by the Octopus Deploy Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior using the instructions in the code of conduct.
This guide provides an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
This project is built, tested, and released by workflows defined in GitHub Actions (see Actions for more information). Release management is controlled through Release-Please.
We ❤️ feedback! Submitting an issue (i.e. feature, bug) is the best way to document things your experience with this project. For example, if there's a feature missing or there's behavior that doesn't match your expectations then we strongly encourage you to submit an issue. That way, contributors can track them and have interested folks (like you) by notified if/when they're resolved.
Use the Issues feature in GitHub to document bugs and/or features related to this project. Please ensure to apply any/all associated metadata (such as labels) in order to classify them appropriately. Also, please provide as much contextual information as you can, especially when documenting bugs. Templates are provided in this project to guide the authoring process.
Issues will be triaged and modified (if necessary) by the CODEOWNERS for this project. It is important to associate pull requests with issues by referencing their issue ID in the commit message. That way, issues will be able to document changes and/or fixes. This will assist visitors when reading through issue lists.
This project employs branch protection; the main branch is protected. Therefore, your changes MUST be committed to a branch and submitted as a pull request. Also, this project requires the use of Conventional Commits for all commit messages. Using Conventional Commits enables this project to autogenerate its CHANGELOG.md and release notes.
Congratulations! 🎉 And thank you very much for your contribution to this project!
Once your pull request is merged, our build and test workflow will execute once again to validate changes. Afterward, your changes will be committed to the main branch.