diff options
author | Aos <aosdab@gmail.com> | 2018-03-04 20:44:15 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-03-04 20:44:15 +0300 |
commit | 35cc7b96162ec7b3d0cf7b6a62150df57638a165 (patch) | |
tree | 3b809bc02571ea58567a3c9383e65ae484636aab /README.md | |
parent | 0f74d74525626b14c41fe2eca1f5150185aa09cc (diff) |
* Added additional documentation to readme file about contributions (#9)
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 18 |
1 files changed, 18 insertions, 0 deletions
@@ -16,6 +16,7 @@ A live version of this theme can be found * [Features](#features) * [Getting Started](#getting-started) * [Customizing](#customizing) +* [Contributing](#contributing) * [License](#license) ## Features @@ -84,5 +85,22 @@ There is also a fixed `About` page on the navbar. Create it using: $ hugo new about ``` +## Contributing +Contributions are welcome. + +**Features**: +If you are adding a feature, fork the repository, create a new branch +for your feature and submit a PR. Please make sure to put documentation for your +new feature: +- Place a small comment about what your feature is doing above the code. +- If making additions that will affect the `config` file, make sure you update + the example `config` in [README](README.md) as well as the + [config.toml](exampleSite/config.toml). + +**Issues/Bugs**: +Submit a new issue with information about your issue and/or bug. If you +have a solution, then submit a new PR with the guidelines posted above in the +**features** section and link your issue to it using the keyword "[*closes*](https://help.github.com/articles/closing-issues-using-keywords/)". + ## License Licensed under the MIT License. See the [LICENSE](LICENSE). |