First off, thanks for taking the time to contribute!
The following is a set of guidelines for contributing to git-hook-commit, which is hosted on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
Please note: I have taken the CONTRIBUTING.md from Atom as a base for this document.
What should I know before I get started?
This project and everyone participating in it is governed by the git-hook-commit Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
git-hook-commit is a small open source project — it started because I wanted to have a configurable git commit hook.
This section guides you through submitting a bug report for git-hook-commit. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
- Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.
Bugs are tracked as GitHub issues. Create an issue and provide the following information by filling in the template.
Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started git-hook-commit, e.g. which command exactly you used in the terminal, or how you started git-hook-commit otherwise. When listing steps, don't just say what you did, but explain how you did it.
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem. If you use the keyboard while following the steps, record the GIF with the Keybinding Resolver shown. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
Provide more context by answering these questions:
- Did the problem start happening recently (e.g. after updating to a new version of git-hook-commit) or was this always a problem?
- If the problem started happening recently, can you reproduce the problem in an older version of git-hook-commit? What's the most recent version in which the problem doesn't happen? You can download older versions of git-hook-commit from the releases page.
- Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
Include details about your configuration and environment:
- Which version of git-hook-commit are you using? You can get the exact version by running
git-hook-commitin your terminal - What's the name and version of the OS you're using?
- Are you using local configuration files?
This section guides you through submitting an enhancement suggestion for git-hook-commit, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.
When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of git-hook-commit which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- Explain why this enhancement would be useful to most git-hook-commit users
- Specify which version of git-hook-commit you're using. You can get the exact version by running
git-hook-commitin your terminal - Specify the name and version of the OS you're using.
- Fill in the required template
- Do not include issue numbers in the PR title
- Include screenshots and animated GIFs in your pull request whenever possible.
- Use gofmt
- Avoid platform-dependent code
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- prepend 'feat', 'fix', 'doc' followed by a colon and a space to the subject line