Add templates for Issues and Pull Requests - Githubissues

crux-bphc / CMS-Android

A custom Moodle app for the students of BITS Pilani, Hyderabad Campus.

MIT License

28 stars 39 forks source link

Add templates for Issues and Pull Requests #74

Open shriakhilc opened 6 years ago

shriakhilc commented 6 years ago

Github supports setting base templates for newly created issues and pull requests. Having well structured templates will ensure that necessary details aren't left out.

Issues should have the following: For bugs:

Description of the error faced (mandatory)
Logs, in case of crash (if available)
Screenshots (if applicable)
Expected resolution (if any decisions involved, apart from fixing the crash itself)

For new feature requests / Current feature enhancements:

Description of the feature needed (mandatory)
Current state of the feature

Pull Requests should have the following:

Link to the corresponding issue that is to be closed
Overview of method used to fix the bug
Mention why a particular implementation was picked, in case multiple options existed.

abhijeetviswa commented 4 years ago

Partially closed after addition of Contribution Guideline and Code of Conduct in 6c0f4ad7d7a6309ee741b9a486a352f1c2df7595.