hollenberry / communicating-with-github

MIT License
0 stars 0 forks source link

Learn about Notifications on GitHub #5

Closed galileo-dev-app[bot] closed 6 years ago

galileo-dev-app[bot] commented 6 years ago

Now that the card is an issue, let's add a label.

Labels are a way to categorize issues and pull requests on GitHub. There are default labels, but you can always customize labels within a repository. You can see these labels from the main list of issues or pull requests, and you can also sort by labels.

To add a label, you click "Labels" on the right hand side of an issue or pull request and select the label you'd like to add.

Activity

  1. Once the card is an issue, add a label for "enhancement".
galileo-dev-app[bot] commented 6 years ago

Whoops, you've added the wrong label to this issue!

galileo-dev-app[bot] commented 6 years ago

Great! You've added a label.

As the body of this issue states, you're going to add an issue template to this repository.

What's an issue template?

When you add an issue template to your repository, project contributors will automatically see the template's contents in the issue form body. Templates customize and standardize the information you'd like included when contributors open issues.

Issue templates, like all issues on GitHub, recognize markdown.

To read more about issue templates, check out GitHub's help documentation.

Closing issues from pull requests

Pull requests often add code that resolves an issue in the same repository. In those cases, GitHub has some special syntax to automate repository housekeeping.

When a pull request or commit references a keyword and issue number, it creates an association between the pull request and the issue. When the pull request is merged into your repository's default branch, the corresponding issue is automatically closed.

In the body of a pull request (the first text, not an additional comment), GitHub is looking for special words:

For example, if the body of a pull request says "This closes #21", and there was an issue #21 in that repository, then #21 would automatically close when that pull request was merged.

Activity

  1. Create a branch called create-issue-template
  2. On that branch, create an empty file named .github/ISSUE_TEMPLATE.md
  3. Open a pull request with base: master and compare: create-issue-template. Use the special syntax to close this issue when the pull request is merged.