Skip to content

Commit

Permalink
CONTRIBUTING.md update
Browse files Browse the repository at this point in the history
Documents actionlint use as part of CI basic workflow including instructions of running locally.

Signed-off-by: JP Lomas <[email protected]>
  • Loading branch information
jplomas committed Sep 10, 2024
1 parent d27fe4c commit f186460
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,20 @@ GitHub CI jobs. When executed in the main `liboqs` directory,

When installing `act` as a GitHub extension, prefix the commands with `gh `.

## Modifications to CI

Modifications to GitHub Actions workflows are checked with [actionlint](https://github.com/rhysd/actionlint) during the [basic.yml](.github/workflows/basic.yml) job, protecting the CI chain and against wrong approval decisions based on improper CI runs. Changes to these workflows can be validated locally with `actionlint`:

```bash
actionlint .github/workflows/*.yml
```

or running the CI locally (as above):

```bash
act workflow_call -W '.github/workflows/basic.yml'
```

### New features

Any PR introducing a new feature is expected to contain a test of this feature
Expand All @@ -70,6 +84,3 @@ add a tag to one or more of our [most active contributors](https://github.com/op

If you feel like contributing but don't know what specific topic to work on,
please check the [open issues tagged "good first issue" or "help wanted"](https://github.com/open-quantum-safe/liboqs/issues).



0 comments on commit f186460

Please sign in to comment.