pythonindia/junction

Add Issue/PR Templates

Opened this issue · 4 comments

Bhupesh-V commented

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

Sc0rpi0n101 commented

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

Bhupesh-V commented

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 🔥 😃 ]

the last 2 can be omitted if not necessary.

A PR template can be like this 👇

<!--- 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.
avats-dev commented

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

ibrahimsha23 commented

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