From 5e66888913c953a05baa71d027a30c0a49879c2a Mon Sep 17 00:00:00 2001 From: Shubham Divekar Date: Thu, 12 Aug 2021 17:16:57 -0700 Subject: [PATCH] Adding a Pull request template (#239) * Adding a Pull request template * Exclude .github from formatting check * Applying PR feedback --- .github/CONTRIBUTING.md | 4 ++++ .github/PULL_REQUEST_TEMPLATE.md | 17 +++++++++++++++++ .github/workflows/ci.yml | 4 +++- 3 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 2ac8b0837..f3598dbde 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -26,6 +26,10 @@ Contributions via pull requests are much appreciated. Before sending us a pull r 1. You are working against the latest source on the *main* branch. 2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already. 3. You open an issue to discuss any significant work - we would hate for your time to be wasted. +4. The size of the PR is small. If the issue requires sizeable code change, you can go with the following: + * Break down the PR into independent components(that do not break the library functionality) and create separate PRs. + * Else, break down the changes into smaller commits and ensure you have a descriptive commit message. + * Provide a helpful description of the change. To send us a pull request, please: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..64d69412d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,17 @@ + + +Description +----------- + + +Checklist: +---------- + + + +- [ ] I have tested my changes. No regression in existing tests. +- [ ] My code is formatted using Uncrustify. +- [ ] I have read and applied the rules stated in CONTRIBUTING.md. + + +By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice. \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 8b98744ef..c123b0759 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -115,7 +115,9 @@ jobs: uses: FreeRTOS/CI-CD-Github-Actions/formatting@main with: path: ./ - exclude-dirs: docs + exclude-dirs: | + docs + .github git-secrets: runs-on: ubuntu-latest