mirror of
https://github.com/sindresorhus/awesome.git
synced 2026-05-08 19:58:37 -05:00
[PR #1589] [MERGED] Add Git Hooks #1700
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
📋 Pull Request Information
Original PR: https://github.com/sindresorhus/awesome/pull/1589
Author: @CompSciLauren
Created: 7/27/2019
Status: ✅ Merged
Merged: 9/22/2019
Merged by: @sindresorhus
Base:
master← Head:patch-1📝 Commits (1)
5f93882Add Git Hooks📊 Changes
1 file changed (+1 additions, -0 deletions)
View changed files
📝
readme.md(+1 -0)📄 Description
https://github.com/CompSciLauren/awesome-git-hooks
This list is about git hooks, scripts that can be customized to automate a wide variety of tasks during git workflows.
By submitting this pull request I confirm I've read and complied with the below requirements 🖖
Yes
Please read it multiple times. I spent a lot of time on these guidelines and most people miss a lot.
Yes
Requirements for your pull request
Don't waste my time. Do a good job, adhere to all the guidelines, and be responsive.
Understood
You have to review at least 2 other open pull requests.
PR: https://github.com/sindresorhus/awesome/pull/1582
PR: https://github.com/sindresorhus/awesome/pull/1585
You have read and understood the instructions for creating a list.
Yes
This pull request has a title in the format
Add Name of List.Yes
Your entry here should include a short description about the project/theme of the list. It should not describe the list itself. The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb.
Yes
Your entry should be added at the bottom of the appropriate category.
Exception requested - Added it to the bottom of the git/GitHub related lists under Development Environment, but that is not the very bottom of the section. The git/GitHub lists seem to be grouped together, so it makes sense to me that git hooks would be with them rather than separate at the bottom. I thought this would be okay, but if moving it to the bottom is preferred still then I will move it.
The suggested Awesome list complies with the below requirements.
Yes
Requirements for your Awesome list
Has been around for at least 30 days.
That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
Yes
Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it.
Waited
Run
awesome-linton your list and fix the reported issues. If there are false-positives or things that cannot/shouldn't be fixed, please report it.Awesome-Lint Passing
Includes a succinct description of the project/theme at the top of the readme. (Example)
Yes
It's the result of hard work and the best I could possibly produce.
If you have not put in considerable effort into your list, your pull request will be immediately closed.
Yes
The repo name of your list should be in lowercase slug format:
awesome-name-of-list.Yes
The heading title of your list should be in title case format:
# Awesome Name of List.Yes
Non-generated Markdown file in a GitHub repo.
Yes
The repo should have
awesome-list&awesomeas GitHub topics. I encourage you to add more relevant topics.Yes, with added topics as well
Not a duplicate. Please search for existing submissions.
Not a duplicate, though other attempts have already been made by others but were not added. I looked through them to make sure I would not run into the same issues discussed in those ones.
Only has awesome items. Awesome lists are curations of the best, not everything.
Yes
Includes a project logo/illustration whenever possible.
Yes
Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
Yes
Includes the Awesome badge.
Yes
Has a Table of Contents section.
Contents, notTable of Contents.Yes, and did not nest any lists. Under "Overview of Hooks" I have nine sub-sections based on the type of hook described. However, the Overview of Hooks section is not terribly long so I didn't think nesting each category was necessary. As more hooks are added over time it could become necessary. I chose to not include a nested list, but I'm open to feedback on this if anyone thinks it would be better to have the categories mentioned in the table of contents.
Has an appropriate license.
That means something like CC0, not a code licence like MIT, BSD, Apache, etc.
WTFPL and Unlicense are not acceptable licenses.
If you use a license badge, it should be SVG, not PNG.
Yes. Uses CC0 license.
To verify that you've read all the guidelines, please add comment with just the word
unicorn.See comments section :)
Has contribution guidelines.
contributing.md. Casing is up to you.Yes
Has consistent formatting and proper spelling/grammar.
Example:
- [AVA](…) - JavaScript test runner.Node.js, notNodeJSornode.js.Yes
Doesn't include a Travis badge.
You can still use Travis for list linting, but the badge has no value in the readme.
No Travis badge
Doesn't include an
Inspired by awesome-fooorInspired by the Awesome projectkinda link at the top of the readme. The Awesome badge is enough.Yes
Go to the top and read it again.
I went through considerable effort to make sure I did everything correctly, re-read it multiple times and compared what I have to previous PRs and other lists in the Awesome list. Optimistic that I did everything correctly but I'll be quick to fix any changes if needed! Thank you for your time!
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.