[Maintenance] Draft and add issues and pull requests templates

[xames3]

• this is a more involved but not a technically challenging issue and could be worked upon in future patches as well. but as of now, it would be ideal to have the below set of acceptance criteria for this successful closure of this issue:

  • need to experiment and draft a relatively simple, easy to follow along and more welcoming pull requests and issue templates. like with every other large scale open-source project, there are million different ways to do this and have a template in place. but for our project and given the level of technical understanding with our contributors, we need to figure out a simple, easy and a less sophisticated way to allow contributors to raise these task. possible good to have template criterion would be:
    • a template which asks why and what
    • template which considers various change types i.e bug fixes, features, tests, etc.
    • template with relative reference links capabilities to address the respective issues.
    • it would be ideal if the template could also allow the contributors to get more specific with their respective platforms as it might be an issue sometimes but certainly not a strict enforcement to have. given what we aim to get out of this repository, it would be very unlikely that contributors would run into platform related issues but still a good possibility to consider.
    • it would be ideal to have a checklist of some obvious tasks before or while the pull request or issue is being opened.
    • one good to have add on would be addressing licensing.
    • allowing optional screenshots, maybe?
  • consider a possibility of multiple templates as it is not natively supported by GitHub as of now. but there is a workaround mentioned in this SO post and a community request.

these are some good references for this issue: GitHub pull request template and How to Create a Good Pull Request Template.

note: this is not an exhaustive list by any means. please explore more options and other open-source repositories on GitHub or StackOverflow using the advanced search filtering option.

[xames3]

• @jfmartinez4, please review the issue. have added a bug reporting issue template and a PR template which can certainly help contributors when raising an issue or reporting a bug or raising a PR.
• shall add one more issue template for feature/documentation request soon.

[jfmartinez4]

@xames3 I'm not entirely sure where the template would live and how extensive it has to be. My worry is that having a template will make further roadblocks to make pull requests. How would people access these templates?

[xames3]

these templates are already added to the repository. the contributors have to just raise a pull request or an issue how they normally do. I'll explain in the coming meeting.