github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-04-20 12:13:05 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update links in CONTRIBUTING.md due to the org transition

Browse source
This commit is contained in:
digitalcraftsman 2017-06-13 19:37:30 +02:00 • committed by GitHub
parent 7b99fb9f1c
commit 95386544e8
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
CONTRIBUTING.md
View file

@ -5,7 +5,7 @@ organization, tutorials, blog posts, bug reports, issues, feature requests,
feature implementations, pull requests, answering questions on the forum, feature implementations, pull requests, answering questions on the forum,
helping to manage issues, etc. helping to manage issues, etc.
The Hugo community and maintainers are [very active](https://github.com/spf13/hugo/pulse/monthly) and helpful, and the project benefits greatly from this activity. We created a [step by step guide](https://gohugo.io/tutorials/how-to-contribute-to-hugo/) if you're unfamiliar with GitHub or contributing to open source projects in general. The Hugo community and maintainers are [very active](https://github.com/gohugoio/hugo/pulse/monthly) and helpful, and the project benefits greatly from this activity. We created a [step by step guide](https://gohugo.io/tutorials/how-to-contribute-to-hugo/) if you're unfamiliar with GitHub or contributing to open source projects in general.
## Table of Contents ## Table of Contents
@ -22,14 +22,14 @@ The Hugo community and maintainers are [very active](https://github.com/spf13/hu
## Asking Support Questions ## Asking Support Questions
We have an active [discussion forum](http://discuss.gohugo.io) where users and developers can ask questions. We have an active [discussion forum](https://discuss.gohugo.io) where users and developers can ask questions.
Please don't use the GitHub issue tracker to ask questions. Please don't use the GitHub issue tracker to ask questions.
## Reporting Issues ## Reporting Issues
If you believe you have found a defect in Hugo or its documentation, use 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. the GitHub [issue tracker](https://github.com/gohugoio/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). If you're not sure if it's a bug or not, start by asking in the [discussion forum](https://discuss.gohugo.io).
When reporting the issue, please provide the version of Hugo in use (`hugo version`) and your operating system. When reporting the issue, please provide the version of Hugo in use (`hugo version`) and your operating system.
## Submitting Patches ## Submitting Patches
@ -48,12 +48,12 @@ To make the contribution process as seamless as possible, we ask for the followi
* Go ahead and fork the project and make your changes. We encourage pull requests to allow for review and discussion of code changes. * Go ahead and fork the project and make your changes. We encourage pull requests to allow for review and discussion of code changes.
* When you’re ready to create a pull request, be sure to: * When you’re ready to create a pull request, be sure to:
* Sign the [CLA](https://cla-assistant.io/spf13/hugo). * Sign the [CLA](https://cla-assistant.io/gohugoio/hugo).
* Have test cases for the new code. If you have questions about how to do this, please ask in your pull request. * 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`. * Run `go fmt`.
* Add documentation if you are adding new features or changing functionality. The docs site lives in `/docs`. * 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`. * Squash your commits into a single commit. `git rebase -i`. It’s okay to force update your pull request with `git push -f`.
* Ensure that `make check` succeeds. [Travis CI](https://travis-ci.org/spf13/hugo) (Linux and macOS) and [AppVeyor](https://ci.appveyor.com/project/spf13/hugo/branch/master) (Windows) will fail the build if `make check` fails. * Ensure that `make check` succeeds. [Travis CI](https://travis-ci.org/gohugoio/hugo) (Linux and macOS) and [AppVeyor](https://ci.appveyor.com/project/gohugoio/hugo/branch/master) (Windows) will fail the build if `make check` fails.
* Follow the **Git Commit Message Guidelines** below. * Follow the **Git Commit Message Guidelines** below.
### Git Commit Message Guidelines ### Git Commit Message Guidelines
@ -94,7 +94,7 @@ You **must use govendor** to fetch and manage Hugo's dependencies.
``` ```
go get github.com/kardianos/govendor go get github.com/kardianos/govendor
govendor get github.com/spf13/hugo govendor get github.com/gohugoio/hugo
``` ```
### Using Git Remotes ### Using Git Remotes
@ -108,7 +108,7 @@ started:
1. Change to the Hugo source directory: 1. Change to the Hugo source directory:
``` ```
cd $HOME/go/src/github.com/spf13/hugo cd $HOME/go/src/github.com/gohugoio/hugo
``` ```
1. Create a new branch for your changes (the branch name is arbitrary): 1. Create a new branch for your changes (the branch name is arbitrary):
@ -142,7 +142,7 @@ started:
### Build Hugo with Your Changes ### Build Hugo with Your Changes
```bash ```bash
cd $HOME/go/src/github.com/spf13/hugo cd $HOME/go/src/github.com/gohugoio/hugo
make hugo make hugo
# or to install in $HOME/go/bin: # or to install in $HOME/go/bin:
make install make install