junction icon indicating copy to clipboard operation
junction copied to clipboard

Add Issue/PR Templates

Open Bhupesh-V opened this issue 5 years ago • 4 comments

Why

  • Will help contributors be more specific while reporting issues (bugs/enhancements etc)
  • Issue Labels can be automatically applied.
  • Helps maintainers, better analyze issues (environment specific problems)

A Demo can be seen while opening a bug report at black

black

Bhupesh-V avatar Jul 06 '20 10:07 Bhupesh-V

So, black has multiple issue templates for different types of issues. Do you think we should also have multiple templates, or one general template?

Sc0rpi0n101 avatar Jul 06 '20 18:07 Sc0rpi0n101

Do you think we should also have multiple templates,

Yes

  • Bug Report
  • Feature Request
  • Question [For clearing doubts regarding codebase/setup etc]
  • Say Thank you [Open if someone likes junction :fire: :smiley: ]

the last 2 can be omitted if not necessary.

A PR template can be like this :point_down:

<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->
<!--- If the Pull Request is a WIP, open a draft PR instead -->

## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->

## Screenshots (if applicable):

## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] 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)

## 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! -->
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have run tests locally.

Bhupesh-V avatar Jul 07 '20 11:07 Bhupesh-V

@palnabarun Is anyone working on this? I want to contribute.

avats-dev avatar Aug 14 '20 04:08 avats-dev

@palnabarun May i work on the issue? Do you have any suggestion on templates, please let me know?

ibrahimsha23 avatar May 08 '21 10:05 ibrahimsha23