Commit graph

40 commits

Author SHA1 Message Date
Bjørn Erik Pedersen
2fbdee7268
Update CONTRIBUTING.md
Add some info about commit subject prefixes.
2022-05-13 11:42:12 +02:00
Anthony Fok
bbd455fe79 Update CONTRIBUTING.md to use "go install" to install mage
In Go 1.18, "go get" no longer builds packages.
2022-03-21 21:01:24 -06:00
Bjørn Erik Pedersen
e792d27017
readme: Add a contribution note 2022-03-16 13:09:17 +01:00
Bjørn Erik Pedersen
60469f429e
Update CONTRIBUTING.md 2021-02-25 11:50:08 +01:00
Fabian Tamp
f3cb0be35a Fix a typo in CONTRIBUTING.md
The URL `git://github.com/USERNAME/hugo.git` is invalid; it should instead be either `https://github.com/USERNAME/hugo.git` or `git@github.com:USERNAME/hugo.git`. I chose the latter for this PR.
2020-08-07 19:35:48 +02:00
Robert Fekete
7eba37ae9b Typo correction 2020-04-07 19:47:44 +02:00
Cameron Moore
7f0ebd4a3c CONTRIBUTING: Fix note about CGO 2020-02-06 09:09:08 +01:00
Bjørn Erik Pedersen
2997310124
Mention a "no CGO rule"
See #6842
2020-02-01 10:27:26 +01:00
Shohei Ueda
0947cf9583 Enhance accessibility to issues
Add links to the Hugo issues, Hugo docs issues, and Hugo website theme issues.

Close #6233
2019-12-14 18:47:23 +01:00
Bjørn Erik Pedersen
fdd4a768f0
Remove appveyor
We now build on Travis for all platforms.
2018-11-13 14:36:17 +01:00
Kris Budhram
3a3089121b Simple doc fix in CONTRIBUTING.md 2018-10-16 13:30:00 +02:00
Bjørn Erik Pedersen
b5e17f7c83
Add GOPATH Hugo building tip 2018-10-09 11:09:00 +02:00
Gregorio Martinez
152cffb13a Update README & CONTRIBUTING
Fix broken links for Dev Chat that point to broken gitter.im room.
Remove lines about `mage vendor` target that is no longer available.
Remove broken table of contents links for headings in CONTRIBUTING.md
Fix typo
2018-10-03 09:50:02 +03:00
Bjørn Erik Pedersen
312d2252be
Update CONTRIBUTING.md 2018-08-29 14:21:20 +02:00
Bjørn Erik Pedersen
dea71670c0
Add Hugo Piper with SCSS support and much more
Before this commit, you would have to use page bundles to do image processing etc. in Hugo.

This commit adds

* A new `/assets` top-level project or theme dir (configurable via `assetDir`)
* A new template func, `resources.Get` which can be used to "get a resource" that can be further processed.

This means that you can now do this in your templates (or shortcodes):

```bash
{{ $sunset := (resources.Get "images/sunset.jpg").Fill "300x200" }}
```

This also adds a new `extended` build tag that enables powerful SCSS/SASS support with source maps. To compile this from source, you will also need a C compiler installed:

```
HUGO_BUILD_TAGS=extended mage install
```

Note that you can use output of the SCSS processing later in a non-SCSSS-enabled Hugo.

The `SCSS` processor is a _Resource transformation step_ and it can be chained with the many others in a pipeline:

```bash
{{ $css := resources.Get "styles.scss" | resources.ToCSS | resources.PostCSS | resources.Minify | resources.Fingerprint }}
<link rel="stylesheet" href="{{ $styles.RelPermalink }}" integrity="{{ $styles.Data.Digest }}" media="screen">
```

The transformation funcs above have aliases, so it can be shortened to:

```bash
{{ $css := resources.Get "styles.scss" | toCSS | postCSS | minify | fingerprint }}
<link rel="stylesheet" href="{{ $styles.RelPermalink }}" integrity="{{ $styles.Data.Digest }}" media="screen">
```

A quick tip would be to avoid the fingerprinting part, and possibly also the not-superfast `postCSS` when you're doing development, as it allows Hugo to be smarter about the rebuilding.

Documentation will follow, but have a look at the demo repo in https://github.com/bep/hugo-sass-test

New functions to create `Resource` objects:

* `resources.Get` (see above)
* `resources.FromString`: Create a Resource from a string.

New `Resource` transformation funcs:

* `resources.ToCSS`: Compile `SCSS` or `SASS` into `CSS`.
* `resources.PostCSS`: Process your CSS with PostCSS. Config file support (project or theme or passed as an option).
* `resources.Minify`: Currently supports `css`, `js`, `json`, `html`, `svg`, `xml`.
* `resources.Fingerprint`: Creates a fingerprinted version of the given Resource with Subresource Integrity..
* `resources.Concat`: Concatenates a list of Resource objects. Think of this as a poor man's bundler.
* `resources.ExecuteAsTemplate`: Parses and executes the given Resource and data context (e.g. .Site) as a Go template.

Fixes #4381
Fixes #4903
Fixes #4858
2018-07-06 11:46:12 +02:00
Adam Jones
b6ededf059 Update CONTRIBUTING.md
Fix typos, simplify language
2018-05-01 18:02:08 +02:00
Bjørn Erik Pedersen
78c863305f
Add some general code contribution criterias 2018-01-23 13:33:51 +01:00
Vas Sudanagunta
1046e9363f Update CONTRIBUTING.md 2018-01-11 17:22:12 +01:00
Bjørn Erik Pedersen
30e471b8c6 Update CONTRIBUTING to reflect Go Dep
Closes #3988
2017-10-21 19:30:23 +02:00
digitalcraftsman
2cc4765670 Add mage installation step to CONTRIBUTING.md 2017-10-05 20:09:21 +02:00
Hallgeir Holien
a6ed645a34 Change last 'make' statements to 'mage' 2017-10-05 17:03:34 +02:00
Bjørn Erik Pedersen
8d2580f07c Replace make with mage
Fixes #3937
2017-10-05 10:53:02 +02:00
Anthony Fok
84710eb3ec Add -u flag for go get govendor in CONTRIBUTING.md
This to to ensure the reader is not stuck with a stale version
of govendor where `govendor get` may not actually build/install
the final hugo binary.

See kardianos/govendor#330
2017-07-28 09:18:20 -06:00
Anthony Fok
0c90e6d710 Change "hugodocs" to "hugoDocs" to match GitHub's default URL 2017-07-21 03:36:44 -06:00
digitalcraftsman
7759a98f71 Clarify the repo choice in the contribution guidelines 2017-07-19 20:53:27 +02:00
digitalcraftsman
720786cd3e Add note about doc-related pull requests in contribution guide 2017-07-18 21:49:16 +02:00
Bjørn Erik Pedersen
4aa1239070 Update links to new discuss URL 2017-06-17 10:06:49 +02:00
digitalcraftsman
95386544e8 Update links in CONTRIBUTING.md due to the org transition 2017-06-13 19:37:30 +02:00
Ricardo N Feliciano
b31da911b5 docs: Properly capitalize GitHub 2017-04-05 18:41:23 +02:00
Anthony Fok
a99661031a docs: Change OS X to macOS in README and CONTRIBUTING 2017-03-15 07:58:58 -06:00
Albert Nigmatzianov
491d406881 docs: Fix CONTRIBUTING.md 2017-03-15 09:27:02 +01:00
Cameron Moore
d6093aba4d docs: Update contributing guides
Add vendoring and make targets.  Require Go 1.8+ and remove mention of
GOPATH (just assume $HOME/go).

Due to time contraints, the contributing tutorial was only slightly
updated to make obvious corrections.

Fixes #3153
2017-03-14 23:03:49 +01:00
digitalcraftsman
6dd57f7a11 docs: Remove waffle.io graph from CONTRIBUTING.md
Fixes #2892
2017-02-24 22:21:58 +01:00
digitalcraftsman
f4afd13386 Enhance commit message guidelines 2016-11-04 19:37:41 +01:00
digitalcraftsman
50c43c36f1 Contributing: Link the "How to contribute" tutorial 2016-09-28 17:25:24 +02:00
Stephan Kulla
d72c454f78 Fix command for getting hugo in CONTRIBUTING.md 2016-08-16 08:56:45 -05:00
Cameron Moore
8b54843a0d hugo: Revert git commit message guidelines 2016-06-17 08:23:43 -05:00
Cameron Moore
373ca66287 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-06-16 16:31:22 -05:00
Bjørn Erik Pedersen
077b0fa71f Add package prefix to the commit message guidelines 2016-03-11 10:30:17 +01:00
Anthony Fok
bd0176a548 Add CONTRIBUTING.md
Extracted from the current README.md
2016-02-05 12:35:42 +08:00