Skip to content

Commit

Permalink
added coc contib and github
Browse files Browse the repository at this point in the history
  • Loading branch information
VI-Suji committed Jun 26, 2021
1 parent 27d9514 commit e0a408f
Show file tree
Hide file tree
Showing 3 changed files with 170 additions and 0 deletions.
55 changes: 55 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/bug_fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
name: Bug fix
about: Change which fixes an issue.
title: ''
labels: ''
assignees: ''

---
# Description

* Please include a summary of the change.
* Please also include relevant motivation and context.
* List any dependencies that are required for this change.

Addresses issues #(issue)

## Type of change

**NB: ~~Please strike through options that are not applicable.~~**

- [ ] Breaking change (fix that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

# Sample Input and output
* Provide screenshots or videos.
* Or provide Input output if run on text terminal.

# How Has This Been Tested?

* Please describe the tests that you ran to verify your changes.
* Provide instructions so we can reproduce.
* Please also list any relevant details for your test configuration


- [ ] Test A
- [ ] Test B

**Test Configuration**:
* Firmware version:
* Hardware:
* Toolchain:
* SDK:

# Checklist:

**NB: ~~Please strike through options that are not applicable.~~**

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules
57 changes: 57 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/new_feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
name: New Feature
about: Change which adds functionality
title: ''
labels: ''
assignees: ''
---

# Description

* Please include a summary of the change.
* Please also include relevant motivation and context.
* List any dependencies that are required for this change.

Fixes #(issue)

## Type of change
**NB: ~~Please strike through options that are not applicable.~~**
- [ ] non-breaking change which fixes an issue
- [ ] Breaking change (feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

# Sample Input and output
* Provide screenshots or videos.
* Or provide code block Input output if run on text terminal as below.
```
$ code block Input output on text terminal.
output
```

# How Has This Been Tested?

* Please describe the tests that you ran to verify your changes.
* Provide instructions so we can reproduce.
* Please also list any relevant details for your test configuration

- [ ] Test A
- [ ] Test B

**Test Configuration**:
* Firmware version:
* Hardware:
* Toolchain:
* SDK:

# Checklist:

**NB: ~~Please strike through options that are not applicable.~~**

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules
58 changes: 58 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/remove_feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
name: Remove Feature
about: Change which removes existing functionality
title: ''
labels: ''
assignees: ''
---

# Description

* Please include a summary of the change.
* Please also include relevant motivation and context.
* List any dependencies that are required for this change.

Fixes #(issue)

## Type of change
**NB: ~~Please strike through options that are not applicable.~~**
- [ ] non-breaking change which fixes an issue
- [ ] Breaking change (feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

# Sample Input and output
* Provide screenshots or videos.
* Or provide code block Input output if run on text terminal as below.
```
$ code block Input output on text terminal.
output
```

# How Has This Been Tested?

* Please describe the tests that you ran to verify your changes.
* Provide instructions so we can reproduce.
* Please also list any relevant details for your test configuration


- [ ] Test A
- [ ] Test B

**Test Configuration**:
* Firmware version:
* Hardware:
* Toolchain:
* SDK:

# Checklist:

**NB: ~~Please strike through options that are not applicable.~~**

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules

0 comments on commit e0a408f

Please sign in to comment.