Skip to content

Commit

Permalink
Update CONTRIBUTING.md with current workflows (#6488)
Browse files Browse the repository at this point in the history
  • Loading branch information
achamayou authored Sep 20, 2024
1 parent 3cf06af commit b39fa24
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@ to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simpl
Note that we only accept pull requests from forks so please fork the CCF repository before making any changes. You should contribute your changes on a branch on that fork and create a pull request on the [microsoft/CCF repository](https://github.com/microsoft/CCF/compare) from there.

All pull requests must pass a suite of CI tests before they are merged.
Test commands are defined in [`test.yml`](https://github.com/microsoft/CCF/blob/main/.azure-pipelines-templates/test.yml), so you can locally repeat any tests which fail.
Test commands are defined in [`ci.yml`](https://github.com/microsoft/CCF/blob/main/.github/workflows/ci.yml), so you can locally repeat any tests which fail.

Code must also meet format requirements enforced by [`checks.yml`](https://github.com/microsoft/CCF/blob/main/.azure-pipelines-templates/checks.yml), which can be checked locally by running [`scripts/ci-checks.sh`]. Some formatting issues can be fixed automatically by running [`scripts/ci-checks.sh -f`].
Code must also meet format requirements enforced by [`checks`](https://github.com/microsoft/CCF/blob/main/.github/workflows/ci.yml#L20), which can be checked locally by running [`scripts/ci-checks.sh`]. Some formatting issues can be fixed automatically by running [`scripts/ci-checks.sh -f`].

Other workflows [are available](https://github.com/microsoft/CCF/blob/main/.github/workflows/README.md), and may be used to refresh base images, cut releases, or run longer or performance tests.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
Expand Down

0 comments on commit b39fa24

Please sign in to comment.