Skip to content

Commit 5e66888

Browse files
Adding a Pull request template (#239)
* Adding a Pull request template * Exclude .github from formatting check * Applying PR feedback
1 parent 813dcbc commit 5e66888

File tree

3 files changed

+24
-1
lines changed

3 files changed

+24
-1
lines changed

.github/CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ Contributions via pull requests are much appreciated. Before sending us a pull r
2626
1. You are working against the latest source on the *main* branch.
2727
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
2828
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
29+
4. The size of the PR is small. If the issue requires sizeable code change, you can go with the following:
30+
* Break down the PR into independent components(that do not break the library functionality) and create separate PRs.
31+
* Else, break down the changes into smaller commits and ensure you have a descriptive commit message.
32+
* Provide a helpful description of the change.
2933

3034
To send us a pull request, please:
3135

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<!--- Title -->
2+
3+
Description
4+
-----------
5+
<!--- Describe your changes in detail -->
6+
7+
Checklist:
8+
----------
9+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
10+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
11+
<!--- Please refer to CONTRIBUTING.md for further guidelines -->
12+
- [ ] I have tested my changes. No regression in existing tests.
13+
- [ ] My code is formatted using Uncrustify.
14+
- [ ] I have read and applied the rules stated in CONTRIBUTING.md.
15+
16+
17+
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

.github/workflows/ci.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,9 @@ jobs:
115115
uses: FreeRTOS/CI-CD-Github-Actions/formatting@main
116116
with:
117117
path: ./
118-
exclude-dirs: docs
118+
exclude-dirs: |
119+
docs
120+
.github
119121
120122
git-secrets:
121123
runs-on: ubuntu-latest

0 commit comments

Comments
 (0)