From 9ce648930872e58ee548282125ebf23bb6edf376 Mon Sep 17 00:00:00 2001 From: Soren Ptak Date: Tue, 10 Oct 2023 09:18:17 -0700 Subject: [PATCH 1/2] Remove the github secret from the link verifier --- .github/workflows/ci.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a08d0ca74..7760fe5a4 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -163,8 +163,6 @@ jobs: steps: - uses: actions/checkout@v3 - name: Check Links - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} uses: FreeRTOS/CI-CD-Github-Actions/link-verifier@main with: path: ./ From 16dd378ba04099a70022062771920726e8b1eaf5 Mon Sep 17 00:00:00 2001 From: Soren Ptak Date: Tue, 10 Oct 2023 11:03:44 -0700 Subject: [PATCH 2/2] Add the link to the CONTRIBUTING.md to the README.md. Point to the FreeRTOS Style guide --- .github/CONTRIBUTING.md | 2 +- README.md | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ec3c64905..e84e0ed6f 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -31,7 +31,7 @@ To send us a pull request, please: 1. Fork the repository. 1. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change. -1. Ensure that your contributions conform to the [style guide](https://docs.aws.amazon.com/embedded-csdk/202011.00/lib-ref/docs/doxygen/output/html/guide_developer_styleguide.html). +1. Ensure that your contributions conform to the [style guide](https://www.freertos.org/FreeRTOS-Coding-Standard-and-Style-Guide.html). 1. Format your code with uncrustify, using the config available in [FreeRTOS/CI-CD-Github-Actions](/~https://github.com/FreeRTOS/CI-CD-Github-Actions/blob/main/formatting/uncrustify.cfg). 1. Ensure local tests pass. 1. Commit to your fork using clear commit messages. diff --git a/README.md b/README.md index 46096af2e..81c3194e7 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,9 @@ of the [FreeRTOS 202210.00 LTS](/~https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202210.00-LTS) release.** +Also for contributing and creating a Pull Request please refer to +[the instructions here](.github/CONTRIBUTING.md#contributing-via-pull-request). + ## MQTT Config File The MQTT client library exposes build configuration macros that are required for