https://github.com/lararosekelley/github-templates

Good templates for the issue, pull request, and contributing templates on GitHub, GitLab, and Bitbucket.
https://github.com/lararosekelley/github-templates

bitbucket contributing git-alias github gitlab issue-template pull-request-template shell-scripts starter-files templates

Last synced: 3 months ago
JSON representation

Good templates for the issue, pull request, and contributing templates on GitHub, GitLab, and Bitbucket.

• Host: GitHub
• URL: https://github.com/lararosekelley/github-templates
• Owner: lararosekelley
• License: mit
• Created: 2016-04-07T14:51:47.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2018-06-04T03:34:11.000Z (over 6 years ago)
• Last Synced: 2024-10-15T03:53:25.061Z (4 months ago)
• Topics: bitbucket, contributing, git-alias, github, gitlab, issue-template, pull-request-template, shell-scripts, starter-files, templates
• Language: Shell
• Homepage:
• Size: 25.4 KB
• Stars: 70
• Watchers: 2
• Forks: 27
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub Templates

> Good template for GitHub's ISSUE_TEMPLATE.md, CONTRIBUTING.md, and PULL_REQUEST_TEMPLATE.md files.

[![Build Status](https://travis-ci.org/tylucaskelley/github-templates.svg?branch=master)](https://travis-ci.org/tylucaskelley/github-templates)

---

## Installation

Simply download the needed files by running this from your root project folder:

```sh

$ bash -c "$(curl -s https://raw.githubusercontent.com/tylucaskelley/github-templates/master/install.sh)"

```

For convenience, you can create a Git alias in your `~/.gitconfig` file. Under the `[alias]` section, add the following

so you can run `git tpl` to generate your template files:

```sh

tpl = "!f() { bash -c \"$(curl -s https://raw.githubusercontent.com/tylucaskelley/github-templates/master/install.sh)\"; }; f"

```

When you run `git tpl`, you'll be prompted for your username, email address, and repository name - you can leave the

defaults if they look correct (inferred from `git config` variables).

## Adding your code style guidelines

You should replace the `{guidelines}` section in [CONTRIBUTING.md](CONTIRBUTING.md) with your own code style guidelines

after installation.

## Adding your Git workflow

[CONTRIBUTING.md](CONTIRBUTING.md#submitting-pull-requests) assumes a forking / feature-branch workflow for making

contributions to your repository; edit this if your project requires a different flow.

## Contributing

See [CONTRIBUTING.md](.github/CONTRIBUTING.md).

## License

Copyright (c) 2017-2018 Ty-Lucas Kelley. MIT License.