diff options
author | Bjørn Erik Pedersen <[email protected]> | 2018-01-23 13:33:51 +0100 |
---|---|---|
committer | Bjørn Erik Pedersen <[email protected]> | 2018-01-23 13:33:51 +0100 |
commit | 78c863305f337ed4faf3cf0a23675f28b0ae5641 (patch) | |
tree | a0d255247f73cd7fc73938ff167d5a4537fc7166 /CONTRIBUTING.md | |
parent | 22ad1ebdbb6b4bb97ca3a9a847143e7135a584b8 (diff) | |
download | hugo-78c863305f337ed4faf3cf0a23675f28b0ae5641.tar.gz hugo-78c863305f337ed4faf3cf0a23675f28b0ae5641.zip |
Add some general code contribution criterias
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 06375995b..9933e55a1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,6 +36,23 @@ the GitHub [issue tracker](https://github.com/gohugoio/hugo/issues) to report th If you're not sure if it's a bug or not, start by asking in the [discussion forum](https://discourse.gohugo.io). When reporting the issue, please provide the version of Hugo in use (`hugo version`) and your operating system. +## Code Contribution + +Hugo has become a fully featured static site generator, so any new functionality must meet these criterias: + +* It must be useful to many. +* It must fit natural into _what Hugo does best._ +* It must strive not to break existing sites. +* It must close ur update an open [Hugo issue](https://github.com/gohugoio/hugo/issues) +* If it is of some complexity, the contributor is expected to maintain and support the new future (answer questions on the forum, fix any bugs etc.). + +So, to avoid doing unneeded work, it is recommended to open up a discussion on the [Hugo Forum](https://discourse.gohugo.io/) to get some acceptance that this is a good idea. Also, if this is a complex feature, create a small design proposal on the [Hugo issue tracker](https://github.com/gohugoio/hugo/issues) before you start coding. + + +**Bug fixes are, of course, always welcome.** + + + ## Submitting Patches The Hugo project welcomes all contributors and contributions regardless of skill or experience level. |