Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal: Adding PR and Issue Templates #84

Closed
aroramrinaal opened this issue Jun 16, 2023 · 2 comments · Fixed by #222
Closed

Proposal: Adding PR and Issue Templates #84

aroramrinaal opened this issue Jun 16, 2023 · 2 comments · Fixed by #222

Comments

@aroramrinaal
Copy link

I propose adding pull request (PR) and issue templates to improve the contribution process and communication within the project. PR templates provide structure for clear submissions, while issue templates help in creating well-structured reports. These templates ensure consistency, improve communication, and streamline the process.

Benefits:

  • Consistency: Standardized templates bring consistency to PRs and issues.
  • Improved Communication: Clear templates reduce back-and-forth exchanges for missing details.
  • Streamlined Process: Templates make it easier for contributors, maintainers, and reviewers.

I'm willing to contribute to creating these templates and welcome feedback from the community on the specific sections and information to include.

@jebarpg
Copy link
Contributor

jebarpg commented Jun 17, 2023

Here's my templates of the templates to help you get started:
btw these typically go into the directories '.github\ISSUE_TEMPLATE\ISSUE_TEMPLATE.md' and '.github\PULL_REQUEST_TEMPLATE\PULL_REQUEST_TEMPLATE.md'

as explained here:
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

# Pull Request Template

## Description

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

Fixes # (issue)

## Type of change

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

## 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:

- [ ] 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
- [ ] I have checked my code and corrected any misspellings
# Issue Template

## Prerequisites

Please answer the following questions for yourself before submitting an issue. **YOU MAY DELETE THE PREREQUISITES SECTION.**

- [ ] I am running the latest version
- [ ] I checked the documentation and found no answer
- [ ] I checked to make sure that this issue has not already been filed
- [ ] I'm reporting the issue to the correct repository (for multi-repository projects)

## Context

Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions.

* Firmware Version:
* Operating System:
* SDK version:
* Toolchain version:

## Expected Behavior

Please describe the behavior you are expecting

## Current Behavior

What is the current behavior?

## Failure Information (for bugs)

Please help provide information about the failure if this is a bug. If it is not a bug, please remove the rest of this template.

### Steps to Reproduce

Please provide detailed steps for reproducing the issue.

1. step 1
2. step 2
3. you get it...

### Failure Logs

Please include any relevant log snippets or files here.

@aroramrinaal
Copy link
Author

Okay, I will go ahead and start working on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants