summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
AgeCommit message (Collapse)Author
2023-10-21docs: Remove outdated note from CONTRIBUTING.mdOleksandr Redko
2023-01-31Update CONTRIBUTING.mdBjørn Erik Pedersen
2022-12-24Update CONTRIBUTING.mdBjørn Erik Pedersen
2022-12-24Update CONTRIBUTING.mdBjørn Erik Pedersen
2022-06-13readme: Update dependency listAndreas Deininger
2022-06-07Update CONTRIBUTING.mdBjørn Erik Pedersen
2022-05-13Update CONTRIBUTING.mdBjørn Erik Pedersen
Add some info about commit subject prefixes.
2022-03-21Update CONTRIBUTING.md to use "go install" to install mageAnthony Fok
In Go 1.18, "go get" no longer builds packages.
2022-03-16readme: Add a contribution noteBjørn Erik Pedersen
2021-02-25Update CONTRIBUTING.mdBjørn Erik Pedersen
2020-08-07Fix a typo in CONTRIBUTING.mdFabian Tamp
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-04-07Typo correctionRobert Fekete
2020-02-06CONTRIBUTING: Fix note about CGOCameron Moore
2020-02-01Mention a "no CGO rule"Bjørn Erik Pedersen
See #6842
2019-12-14Enhance accessibility to issuesShohei Ueda
Add links to the Hugo issues, Hugo docs issues, and Hugo website theme issues. Close #6233
2018-11-13Remove appveyorBjørn Erik Pedersen
We now build on Travis for all platforms.
2018-10-16Simple doc fix in CONTRIBUTING.mdKris Budhram
2018-10-09Add GOPATH Hugo building tipBjørn Erik Pedersen
2018-10-03Update README & CONTRIBUTINGGregorio Martinez
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-08-29Update CONTRIBUTING.mdBjørn Erik Pedersen
2018-07-06Add Hugo Piper with SCSS support and much moreBjørn Erik Pedersen
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-05-01Update CONTRIBUTING.mdAdam Jones
Fix typos, simplify language
2018-01-23Add some general code contribution criteriasBjørn Erik Pedersen
2018-01-11Update CONTRIBUTING.mdVas Sudanagunta
2017-10-21Update CONTRIBUTING to reflect Go DepBjørn Erik Pedersen
Closes #3988
2017-10-05Add mage installation step to CONTRIBUTING.mddigitalcraftsman
2017-10-05Change last 'make' statements to 'mage'Hallgeir Holien
2017-10-05Replace make with mageBjørn Erik Pedersen
Fixes #3937
2017-07-28Add -u flag for go get govendor in CONTRIBUTING.mdAnthony Fok
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-21Change "hugodocs" to "hugoDocs" to match GitHub's default URLAnthony Fok
2017-07-19Clarify the repo choice in the contribution guidelinesdigitalcraftsman
2017-07-18Add note about doc-related pull requests in contribution guidedigitalcraftsman
2017-06-17Update links to new discuss URLBjørn Erik Pedersen
2017-06-13Update links in CONTRIBUTING.md due to the org transitiondigitalcraftsman
2017-04-05docs: Properly capitalize GitHubRicardo N Feliciano
2017-03-15docs: Change OS X to macOS in README and CONTRIBUTINGAnthony Fok
2017-03-15docs: Fix CONTRIBUTING.mdAlbert Nigmatzianov
2017-03-14docs: Update contributing guidesCameron Moore
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-02-24docs: Remove waffle.io graph from CONTRIBUTING.mddigitalcraftsman
Fixes #2892
2016-11-04Enhance commit message guidelinesdigitalcraftsman
2016-09-28Contributing: Link the "How to contribute" tutorialdigitalcraftsman
2016-08-16Fix command for getting hugo in CONTRIBUTING.mdStephan Kulla
2016-06-17hugo: Revert git commit message guidelinesCameron Moore
2016-06-16hugo: Update contribution guidelinesCameron Moore
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-11Add package prefix to the commit message guidelinesBjørn Erik Pedersen
2016-02-05Add CONTRIBUTING.mdAnthony Fok
Extracted from the current README.md
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-18 22:49:16 +0000