Repository navigation
Add a contributing guide - #2
Merged
Merged
Conversation
The template had no contributing guide, and every repository created from it inherits the gap. A contributor to an extension repo had to read the workflows to learn how to test locally, what the pull request check does and how a tag becomes a release. Document the local test commands, the Test and Release workflows, the tag rules including the manual-run caveat, the changelog convention, the security route from the organization policy, and the Apache-2.0 contribution term. The text speaks of "this repository" so it stays correct in a derived repo.
mobileoverlord
approved these changes
Nov 19, 2026
mobileoverlord
left a comment
Contributor
There was a problem hiding this comment.
Approved. Checked the tag patterns and v-prefix behavior against release.yml, the tag guard and its manual-run skip against actions extension-release.yml@v1, and the SECURITY.md link. Merge after #1.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The template has no contributing guide, and every repository created from it inherits the gap. A contributor to an extension repo has to read the workflows to learn how to test locally, what the pull request check does and how a tag becomes a release.
Solution
Add a short
CONTRIBUTING.mdthat speaks of "this repository", so it stays correct in a derived repo as well as in the template.Key changes
AVOCADO_DISTRO_*variables. I ran them against a fresh copy of the template with avocado 1.1.0 and all three passed.Reviewer notes
The License section refers to the repository's
LICENSEfile, which is added in #1. Merge that first or together with this. A derived repo that changes its license has to edit this section. I left out whether the Test check is required, because I did not read the branch protection settings.