Skip to content

Commit 90d503f

Browse files
committed
Document availability of additional tasks in development guide
1 parent 3737159 commit 90d503f

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

Diff for: .github/CONTRIBUTING.md

+32
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,38 @@ Everything is now ready to make your contribution to the project, so commit it t
7272

7373
Thanks!
7474

75+
## Common Development Operations
76+
77+
### Running Checks
78+
79+
Checks and tests are set up to ensure the project content is functional and compliant with the established standards.
80+
81+
You can run the full suite of checks by running the following command from a terminal in a path under the repository:
82+
83+
```text
84+
task check
85+
```
86+
87+
### Automatic Corrections
88+
89+
Tools are provided to automatically bring the project into compliance with some of the required checks.
90+
91+
You can make these automatic fixes by running the following command from a terminal in a path under the repository:
92+
93+
```text
94+
task fix
95+
```
96+
97+
### Other Operations
98+
99+
Individual tasks are provided for each specific common validation and automated correction operation. The convenience `check` and `fix` tasks run all of the relevant individual tasks, so it is not necessary for the contributor to use the individual tasks. However, in some cases it may be more efficient to run the single specific task of interest.
100+
101+
You can learn the names of all the available tasks by running the following command from a terminal in a path under the repository:
102+
103+
```text
104+
task --list
105+
```
106+
75107
## Release workflow
76108

77109
Instructions for releasing a new version of the action:

0 commit comments

Comments
 (0)