-
The action should have a readMe having information about the action. It should include :
a. At least one Example workflow (Use example/sample as the heading)
b. Contribution guidelines -
The code owners should be mentioned in a CODEOWNERS file in .github folder. Here is one sample file.
-
For typescript actions, node_modules should:
a. Not be present in master/main branch
b. Be present in releases/* branch (For releasing the action, one should have branches named as releases/v1, releases/v1.2.0) -
Proper branch rules should be set for master/main and releases/* branch.More information on branch rules can be found here.We recommend setting at-least one approval mandatory for PRs.
-
Security and vulnerability BOTs should be set up for the repo. Dependabot alerts and Dependaobot security updates should be set up in the repository Settings.
-
An issue template should be defined to set the default label as need-to-triage.One can follow these steps to set up a template. Make sure the name of the issue template file is
bug-report-feature-request.mdif the template is created using UI or when issue template file is explicitly added. -
The repo should have some standard labels defined. The following labels should be there :
| Label | Description | Color (Optional) |
| need-to-triage | Requires investigation | #fbca04 |
| idle | Inactive for 14 days | #9A777A |
| question | Requiring some clarification | #d876e3 |
| bug | Something is not working | #d73a4a |
| P0 | Action not working | #B60205 |
| P1 | Some scenario broken but workaround exists | #EE3D1D |
| enhancement | Feature request/improved experience | #a2eeef |
| documentation | Improvements or additions to documentation | #0075ca |
| backlog | Planned for future | #bd7e4b |
| performance-issue | Performance improvement required | #0e8a16 |
| waiting-for-customer | Waiting for inputs from customer | #0e8a16 |