8000 Merge pull request #151 from TalAter/patch-1 · daniel4git/github-cheat-sheet@b85d914 · GitHub
[go: up one dir, main page]

Skip to content

Commit b85d914

Browse files
committed
Merge pull request tiimgreen#151 from TalAter/patch-1
Updated with new GitHub contribution files
2 parents 75b034d + 7540099 commit b85d914

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,10 @@ A collection of cool hidden and not so hidden features of Git and GitHub. This c
4646
- [Diff or Patch of Pull Request](#diff-or-patch-of-pull-request)
4747
- [Rendering and diffing images](#rendering-and-diffing-images)
4848
- [Hub](#hub)
49-
- [Contributing Guidelines](#contributing-guidelines)
49+
- [Contribution Guidelines](#contribution-guidelines)
50+
- [CONTRIBUTING file](#contributing-file)
51+
- [ISSUE_TEMPLATE file](#issue_template-file)
52+
- [PULL_REQUEST_TEMPLATE file](#pull_request_template-file)
5053
- [Octicons](#octicons)
5154
- [GitHub Resources](#github-resources)
5255
- [GitHub Talks](#github-talks)
@@ -591,13 +594,33 @@ $ hub clone tiimgreen/toc
591594

592595
[*Check out some more cool commands Hub has to offer.*](https://github.com/github/hub#commands)
593596

594-
### Contributing Guidelines
595-
Adding a `CONTRIBUTING` file to the root of your repository will add a link to your file when a contributor creates an Issue or opens a Pull Request.
597+
### Contribution Guidelines
598+
GitHub supports adding 3 different files which help users contribute to your project.
599+
These files can either be placed in the root of your repository or a `.github` directory under the root.
600+
601+
#### CONTRIBUTING File
602+
Adding a `CONTRIBUTING` or `CONTRIBUTING.md` file to either the root of your repository or a `.github` directory will add a link to your file when a contributor creates an Issue or opens a Pull Request.
596603

597604
![Contributing Guidelines](https://camo.githubusercontent.com/71995d6b0e620a9ef1ded00a04498241c69dd1bf/68747470733a2f2f6769746875622d696d616765732e73332e616d617a6f6e6177732e636f6d2f736b697463682f6973737565732d32303132303931332d3136323533392e6a7067)
598605

599606
[*Read more about contributing guidelines.*](https://github.com/blog/1184-contributing-guidelines)
600607

608+
#### ISSUE_TEMPLATE file
609+
You can define a template for all new issues opened in your project. The content of this file will pre-populate the new issue box when users create new issues. Add an `ISSUE_TEMPLATE` or `ISSUE_TEMPLATE.md` file to either the root of your repository or a `.github` directory.
610+
611+
[*Read more about issue templates.*](https://github.com/blog/2111-issue-and-pull-request-templates)
612+
613+
[Issue template file generator](https://www.talater.com/open-source-templates/)
614+
615+
![GitHub Issue template](https://cloud.githubusercontent.com/assets/25792/13120859/733479fe-d564-11e5-8a1f-a03f95072f7a.png)
616+
617+
#### PULL_REQUEST_TEMPLATE file
618+
You can define a template for all new pull requests opened in your project. The 654D content of this file will pre-populate the text area when users create pull requests. Add a `PULL_REQUEST_TEMPLATE` or `PULL_REQUEST_TEMPLATE.md` file to either the root of your repository or a `.github` directory.
619+
620+
[*Read more about pull request templates.*](https://github.com/blog/2111-issue-and-pull-request-templates)
621+
622+
[Pull request template file generator](https://www.talater.com/open-source-templates/)
623+
601624
### Octicons
602625
GitHubs icons (Octicons) have now been open sourced.
603626

0 commit comments

Comments
 (0)
0