GitHub Templates

In Today’s Web Development World, Git is everlasting and powerful SCM (Source Control Management). GitHub, which is Web based Git SCM Provider online. This Guy play a important role in all open sourced projects where you can see 95% of projects are available in the GitHub.

GitHub is evident for contributors count soared for Open source Projects. Important to note that all Internet Giants like Facebook, Google and Microsoft are created their own organization and published their projects. Lets come to the point, Here we gonna discuss about GitHub Templates.

Why do we need Templates?

  1. GitHub introduces templates for their web forms (Issues, Pull Request etc), which can configure inputs to be pre-filled with data which will help maintainers to set up questionnaire and help contributors to do their part bit fast.
  2. It’s hard and tough to solve a problem when important details are missing in Pull Request or in Issues by the Contributors. Both are Web forms in GitHub where you can submit without description like below which cause contributions meaning less.
Bad Request — Pull Request with Empty Description

Let’s talk about the above Pull Request where Title and commit Message says Header Changes, It’s hard to fathom this code change by Reviewers. It may be great contribution but reviewers will become dumber and these kinds of code will give rough idea which is at high risk. It may introduce new defects because they are not very clear about the current and new behavior.

How about with description, Lets have a look!

Pull Request with Description

Above one is good and descriptive which can be understand by targeted people but still cannot be understand by our Non Techies like Scrum Masters, Project Managers, Product Owners etc, that’s not our problem but our goal is to value the contributions and issue request which will reviewed and merged super fast than as-usual.

So GitHub Templates Solve this problem?

Yes. GitHub Templates helps to configure your Templates which will help to configure questionnaire. Now maintainers can add templates but make sure your template file names are having right conventions. below is example for ISSUE Template.

GitHub Tempaltes — https://github.com/blog/2111-issue-and-pull-request-templates

Its always good to categorize your request which may be Pull Request or Issue. Please follow the Things you should know section for few more templates in various use cases provided by GitHub.

Things you should know.

  1. Add PULL_REQUEST_TEMPLATE.md for Pull Request Template.
  2. Add Issue_TEMPLATE.md for Issue Template.
  3. Add CONTRIBUTING.md for Contribution Guidelines.
  4. Add CODE_OF_CONDUCT.md for Setting Coding Standard Guidelines.
  5. Add LICENSE or LICENSE.txt for License.
  6. You can keep it in the root directory or move all of them under directory called .github which is recently supported.
  7. A file extension is optional, but Markdown files (.md) are supported.

You are done, check how it look like !

GitHub — https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/
GitHub — https://help.github.com/articles/creating-an-issue-template-for-your-repository/

Cool, Isn’t it !!

Happy Coding, Stay tuned for next one !