Skip to content

Commit

Permalink
Document availability of additional tasks in development guide
Browse files Browse the repository at this point in the history
  • Loading branch information
per1234 committed Oct 7, 2024
1 parent 3737159 commit 90d503f
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,38 @@ Everything is now ready to make your contribution to the project, so commit it t

Thanks!

## Common Development Operations

### Running Checks

Checks and tests are set up to ensure the project content is functional and compliant with the established standards.

You can run the full suite of checks by running the following command from a terminal in a path under the repository:

```text
task check
```

### Automatic Corrections

Tools are provided to automatically bring the project into compliance with some of the required checks.

You can make these automatic fixes by running the following command from a terminal in a path under the repository:

```text
task fix
```

### Other Operations

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.

You can learn the names of all the available tasks by running the following command from a terminal in a path under the repository:

```text
task --list
```

## Release workflow

Instructions for releasing a new version of the action:
Expand Down

0 comments on commit 90d503f

Please sign in to comment.