Responsively-app: Create Issue and PR templates for the Repo

[sidthesloth92]

The idea is to create an issue and PR template so that it's much easier to report bugs and to lay down some basic requirements for a PR.

P.S: The idea is not to scare people away from reporting issues or raising PR's though.. 👻

[open-collective-bot[bot]]

Hey @sidthesloth92 :wave:,

Thank you for opening an issue. We will get back to you as soon as we can. Also, check out our Open Collective and consider contributing financially.

https://opencollective.com/responsively

PS.: We offer priority support for all financial contributors. Don't forget to add priority label once you start contributing :smile:

[sidthesloth92]

For Issue Creation

🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅

Hi there! 😄

To expedite issue processing please search open and closed issues before submitting a new one. Existing issues often contain information about workarounds, resolution, or progress updates.

🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅
^^^
_Will be commented out. Only the creator of the issue can see it._

🐞 bug report

✍️ Description

A clear and concise description of the problem. _<-- Will be commented out. Only the creator of the issue can see it._

🕵🏼‍♂️ Is this a regression?

Did this behavior use to work in the previous version? _<-- Will be commented out. Only the creator of the issue can see it._

🔬 Minimal Reproduction

Clear steps to re-produce the issue. _<-- Will be commented out. Only the creator of the issue can see it._

🌍 Your Environment

Press Ctrl/Cmd + F1 and paste it here.

🔥 Exception or Error or Screenshot

[sidthesloth92]

🚀 feature request

📝 Description

A clear and concise description of the problem or missing capability. _<-- Will be commented out. Only the creator of the issue can see it._can see.

✨ Describe the solution you'd like

If you have a solution in mind, please describe it. _<-- Will be commented out. Only the creator of the issue can see it._

✍️ Describe alternatives you've considered

Have you considered any alternative solutions or workarounds? _<-- Will be commented out. Only the creator of the issue can see it._

[sidthesloth92]

✨ Pull Request

📓 Referenced Issue

Please link the related issue. Use # before the issue number and use the verbs 'fixes', 'resolves' to auto-link it, for eg, Fixes: #498 _<-- Will be commented out. Only the creator of PR can see._

ℹ️ About the PR

Please provide a description of your solution if it is not clear in the related issue or if the PR has a breaking change. If there is an interesting topic to discuss or you have questions or there is an issue with electron or another library that you have used. _<-- Will be commented out. Only the creator of PR can see._

🖼️ Testing Scenarios / Screenshots

Please include screenshots or gif to showcase the final output. Also, try to explain the testing you did to validate your change. _<-- Will be commented out. Only the creator of PR can see._

[sidthesloth92]

@manojVivek @jjavierdguezas Certain lines will be commented out in the actual issue/PR. I just added them here for review. Once we have finalized the verbiage, I'll create a PR for the same.

[manojVivek]

@sidthesloth92 For the pull request format, most of this info will already be there on the referenced issue. So should we need these added again?

[sidthesloth92]

Totally valid, I'll remove some of the stuff from the Issues.

[sidthesloth92]

@manojVivek I've leaned it down.

[manojVivek]

@sidthesloth92 To be honest, it still feels like too much information to me. 😀 Questions inline.

📓 PR Type

What kind of change does this PR introduce?

Can we change this to something like "reference issue"? So that we can have the issue linked to the PR.

✔️ PR Checklist

Please check if your PR fulfils the following requirements:

• [x] The commit message follows our guidelines
• [ ] Tests for the changes have been added (for bug fixes / features)
• [ ] Docs have been added / updated (for bug fixes / features)

I feel these are valid only after the standards have been defined and followed. We don't have a commit message guidelines. And we don't have base unit-test scenarios setup. I feel these points will be effective only after those things are in place.

🆕 What is the new behaviour?

This will be covered in the referenced issue too right?

@jjavierdguezas Please let us know your thoughts too.

[jjavierdguezas]

@manojVivek @sidthesloth92
The bug/feature templates are ok to me
I agree with @manojVivek about the PR template, for now we just need these points:

• related issue (_"please link the related issue, use # before the issue number and use the verbs 'fixes' , 'resolves' , etc to auto link it"_)
• Comments to help the code review and manual tests (_"please provide a description of your solution if it is not clear in the related issue, or you made a breaking change, there is an interesting topic to discuss, you have questions or there is an issue with electron or another library that you sorted"_)
  
  
  
  • Screenshot (_"please include screenshots, gif or video of your work before and after if that helps to understand it better"_)
  
  

I think we can see the other things in the commits

[sidthesloth92]

@manojVivek and @jjavierdguezas All done.. :D Thanks for your inputs.. 👍🏽 @manojVivek The checklist was more for the future, we will soon get there.. 🗡️

[manojVivek]

@sidthesloth92 It looks good now, please let's go ahead.
We can tweak it by observing the usage.