Skip to content

Commit

Permalink
Adding a Pull request template (#239)
Browse files Browse the repository at this point in the history
* Adding a Pull request template

* Exclude .github from formatting check

* Applying PR feedback
  • Loading branch information
divekarshubham authored Aug 13, 2021
1 parent 813dcbc commit 5e66888
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 1 deletion.
4 changes: 4 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
17 changes: 17 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!--- Title -->

Description
-----------
<!--- Describe your changes in detail -->

Checklist:
----------
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
<!--- Please refer to CONTRIBUTING.md for further guidelines -->
- [ ] 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.
4 changes: 3 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 5e66888

Please sign in to comment.