Skip to content

Add a contributing guide - #2

Merged
jetm merged 1 commit into
mainfrom
misc-1112/add-contributing
Nov 19, 2026
Merged

jetm merged 1 commit into
mainfrom
misc-1112/add-contributing

Conversation

@jetm

@jetm jetm commented Nov 19, 2026

Copy link
Copy Markdown
Contributor

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.md that speaks of "this repository", so it stays correct in a derived repo as well as in the template.

Key changes

  • The three local test commands with the two AVOCADO_DISTRO_* variables. I ran them against a fresh copy of the template with avocado 1.1.0 and all three passed.
  • What the Test and Release workflows do, the tag rules, and the manual-run caveat in the tag guard.
  • The changelog convention, the security route from the organization policy, and the Apache-2.0 contribution term.

Reviewer notes

The License section refers to the repository's LICENSE file, 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.

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 mobileoverlord left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@jetm
jetm merged commit 45302a9 into main Nov 19, 2026
1 check passed
@jetm
jetm deleted the misc-1112/add-contributing branch November 19, 2026 19:42
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.

2 participants