github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-07 20:30:36 -05:00
Code Issues Projects Releases Packages Wiki Activity
hugo/CONTRIBUTING.md

157 lines
6.2 KiB
Markdown
Raw Normal View History

Add CONTRIBUTING.md Extracted from the current README.md
2016-02-04 23:35:42 -05:00
# Contributing to Hugo
hugo: Update contribution guidelines Refactor the contribution guidelines in the README and CONTRIBUTING files. Simplify the contribution guide in the README and move most of the complex stuff into CONTRIBUTING. Add an explicit commit message guidelines section to CONTRIBUTING. Keep all of the guidelines from Chris Beams except for the 72 character line limit (we don't follow that, nor does the Go team). Add three new guidelines: package prefix in subject, references in body, and encouragement of message body in general. Add a new section to CONTRIBUTING on using Git Remotes.
2016-03-12 18:35:06 -05:00
We welcome contributions to Hugo of any kind including documentation, themes,
organization, tutorials, blog posts, bug reports, issues, feature requests,
feature implementations, pull requests, answering questions on the forum,
helping to manage issues, etc.
Add CONTRIBUTING.md Extracted from the current README.md
2016-02-04 23:35:42 -05:00
hugo: Update contribution guidelines Refactor the contribution guidelines in the README and CONTRIBUTING files. Simplify the contribution guide in the README and move most of the complex stuff into CONTRIBUTING. Add an explicit commit message guidelines section to CONTRIBUTING. Keep all of the guidelines from Chris Beams except for the 72 character line limit (we don't follow that, nor does the Go team). Add three new guidelines: package prefix in subject, references in body, and encouragement of message body in general. Add a new section to CONTRIBUTING on using Git Remotes.
2016-03-12 18:35:06 -05:00
The Hugo community and maintainers are very active and helpful, and the project benefits greatly from this activity.
Add CONTRIBUTING.md Extracted from the current README.md
2016-02-04 23:35:42 -05:00
[![Throughput Graph](https://graphs.waffle.io/spf13/hugo/throughput.svg)](https://waffle.io/spf13/hugo/metrics)
hugo: Update contribution guidelines Refactor the contribution guidelines in the README and CONTRIBUTING files. Simplify the contribution guide in the README and move most of the complex stuff into CONTRIBUTING. Add an explicit commit message guidelines section to CONTRIBUTING. Keep all of the guidelines from Chris Beams except for the 72 character line limit (we don't follow that, nor does the Go team). Add three new guidelines: package prefix in subject, references in body, and encouragement of message body in general. Add a new section to CONTRIBUTING on using Git Remotes.
2016-03-12 18:35:06 -05:00
## Table of Contents
Add CONTRIBUTING.md Extracted from the current README.md
2016-02-04 23:35:42 -05:00
hugo: Update contribution guidelines Refactor the contribution guidelines in the README and CONTRIBUTING files. Simplify the contribution guide in the README and move most of the complex stuff into CONTRIBUTING. Add an explicit commit message guidelines section to CONTRIBUTING. Keep all of the guidelines from Chris Beams except for the 72 character line limit (we don't follow that, nor does the Go team). Add three new guidelines: package prefix in subject, references in body, and encouragement of message body in general. Add a new section to CONTRIBUTING on using Git Remotes.
2016-03-12 18:35:06 -05:00
* [Asking Support Questions](#asking-support-questions)
* [Reporting Issues](#reporting-issues)
* [Submitting Patches](#submitting-patches)
* [Code Contribution Guidelines](#code-contribution-guidelines)
* [Git Commit Message Guidelines](#git-commit-message-guidelines)
* [Using Git Remotes](#using-git-remotes)
* [Build Hugo with Your Changes](#build-hugo-with-your-changes)
* [Add Compile Information to Hugo](#add-compile-information-to-hugo)
Add CONTRIBUTING.md Extracted from the current README.md
2016-02-04 23:35:42 -05:00
hugo: Update contribution guidelines Refactor the contribution guidelines in the README and CONTRIBUTING files. Simplify the contribution guide in the README and move most of the complex stuff into CONTRIBUTING. Add an explicit commit message guidelines section to CONTRIBUTING. Keep all of the guidelines from Chris Beams except for the 72 character line limit (we don't follow that, nor does the Go team). Add three new guidelines: package prefix in subject, references in body, and encouragement of message body in general. Add a new section to CONTRIBUTING on using Git Remotes.
2016-03-12 18:35:06 -05:00
## Asking Support Questions
Add CONTRIBUTING.md Extracted from the current README.md
2016-02-04 23:35:42 -05:00
hugo: Update contribution guidelines Refactor the contribution guidelines in the README and CONTRIBUTING files. Simplify the contribution guide in the README and move most of the complex stuff into CONTRIBUTING. Add an explicit commit message guidelines section to CONTRIBUTING. Keep all of the guidelines from Chris Beams except for the 72 character line limit (we don't follow that, nor does the Go team). Add three new guidelines: package prefix in subject, references in body, and encouragement of message body in general. Add a new section to CONTRIBUTING on using Git Remotes.
2016-03-12 18:35:06 -05:00
We have an active [discussion forum](http://discuss.gohugo.io) where users and developers can ask questions.
Please don't use the Github issue tracker to ask questions.
## Reporting Issues
If you believe you have found a defect in Hugo or its documentation, use
the Github [issue tracker](https://github.com/spf13/hugo/issues) to report the problem to the Hugo maintainers.
If you're not sure if it's a bug or not, start by asking in the [discussion forum](http://discuss.gohugo.io).
When reporting the issue, please provide the version of Hugo in use (`hugo version`) and your operating system.
## Submitting Patches
The Hugo project welcomes all contributors and contributions regardless of skill or experience level.
If you are interested in helping with the project, we will help you with your contribution.
Hugo is a very active project with many contributions happening daily.
Because we want to create the best possible product for our users and the best contribution experience for our developers,
we have a set of guidelines which ensure that all contributions are acceptable.
The guidelines are not intended as a filter or barrier to participation.
If you are unfamiliar with the contribution process, the Hugo team will help you and teach you how to bring your contribution in accordance with the guidelines.
### Code Contribution Guidelines
To make the contribution process as seamless as possible, we ask for the following:
* Go ahead and fork the project and make your changes. We encourage pull requests to allow for review and discussion of code changes.
Add CONTRIBUTING.md Extracted from the current README.md
2016-02-04 23:35:42 -05:00
* When you’re ready to create a pull request, be sure to:
hugo: Update contribution guidelines Refactor the contribution guidelines in the README and CONTRIBUTING files. Simplify the contribution guide in the README and move most of the complex stuff into CONTRIBUTING. Add an explicit commit message guidelines section to CONTRIBUTING. Keep all of the guidelines from Chris Beams except for the 72 character line limit (we don't follow that, nor does the Go team). Add three new guidelines: package prefix in subject, references in body, and encouragement of message body in general. Add a new section to CONTRIBUTING on using Git Remotes.
2016-03-12 18:35:06 -05:00
* Sign the [CLA](https://cla-assistant.io/spf13/hugo).
* Have test cases for the new code. If you have questions about how to do this, please ask in your pull request.
* Run `go fmt`.
* Add documentation if you are adding new features or changing functionality. The docs site lives in `/docs`.
* Squash your commits into a single commit. `git rebase -i`. It’s okay to force update your pull request with `git push -f`.
* Make sure `go test ./...` passes, and `go build` completes. [Travis CI](https://travis-ci.org/spf13/hugo) (Linux and OS X) and [AppVeyor](https://ci.appveyor.com/project/spf13/hugo/branch/master) (Windows) will catch most things that are missing.
* Follow the **Git Commit Message Guidelines** below.
### Git Commit Message Guidelines
Quality Git commit messages are important in a large project to keep everyone informed;
therefore, we've established the following guidelines:
1. Prefix the subject with the primary affected **package**.
1. After the package prefix, **capitalize** the subject.
1. End the subject **without punctuation**.
1. Use the **imperative** mood in the subject.
1. Limit the subject line to **50** characters.
1. Separate subject from body with a **blank line**.
1. Use the body to explain **what** and **why** instead of **how**.
1. If there is a helpful **reference** like a Github issue, mention it in the body
(ie. "Fixes #123" or "See #123").
1. A message **body** is often desirable unless the code changes are trivial.
To understand the rationales for many of these guidelines,
read [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit) by Chris Beams.
An example:
```text
tpl: Add custom index function
Add a custom index template function that deviates from the stdlib simply by not
returning an "index out of range" error if an array, slice or string index is
out of range. Instead, we just return nil values. This should help make the
new default function more useful for Hugo users.
Fixes #1949
```
### Using Git Remotes
Due to the way Go handles package imports, the best approach for working on a
Hugo fork is to use Git Remotes. Here's a simple walk-through for getting
started:
1. Get the latest Hugo sources:
```
go get -u -t github.com/spf13/hugo
```
1. Change to the Hugo source directory:
```
cd $GOPATH/src/github.com/spf13/hugo
```
1. Create a new branch for your changes (the branch name is arbitrary):
```
git checkout -b iss1234
```
1. After making your changes, commit them to your new branch:
```
git commit -a -v
```
1. Fork Hugo in Github.
1. Add your fork as a new remote (the remote name, "fork" in this example, is arbitrary):
```
git remote add fork git://github.com/USERNAME/hugo.git
```
1. Push the changes to your new remote:
```
git push --set-upstream fork iss1234
```
1. You're now ready to submit a PR based upon the new branch in your forked repository.
### Build Hugo with Your Changes
```bash
cd $GOPATH/src/github.com/spf13/hugo
go build
mv hugo /usr/local/bin/
```
### Add Compile Information to Hugo
To add compile information to Hugo, replace the `go build` command with the following *(replace `/path/to/hugo` with the actual path)*:
go build -ldflags "-X /path/to/hugo/hugolib.CommitHash=`git rev-parse --short HEAD 2>/dev/null` -X github.com/spf13/hugo/hugolib.BuildDate=`date +%FT%T%z`"
This will result in `hugo version` output that looks similar to:
Hugo Static Site Generator v0.13-DEV-8042E77 buildDate: 2014-12-25T03:25:57-07:00
Alternatively, just run `make` — all the “magic” above is already in the `Makefile`. :wink:
Reference in a new issue Copy permalink