From 666286d91775064db935b98db0bf1e34dd73bd9a Mon Sep 17 00:00:00 2001 From: Alexander Bilz <mail@alexbilz.com> Date: Fri, 11 Feb 2022 10:02:18 +0000 Subject: [PATCH] docs: added contribution guidelines (#304) --- .github/CONTRIBUTING.md | 26 ++++++++++++++++++++++++++ README.md | 9 +++++++-- 2 files changed, 33 insertions(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..c2e8834 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,26 @@ +# Contributing to Anatole + +All contributions (including features, translations, code cleanups, improved documentation & bugs reporting) are welcome. + +## Issues + +Issues are very valuable to this project. + +When you create an issue to report a bug or ask a question, please fill out the necessary template. There is one template for filing a [bug](https://github.com/lxndrblz/anatole/blob/master/.github/ISSUE_TEMPLATE/bug_report.md) and one for requesting a new [feature](https://github.com/lxndrblz/anatole/blob/master/.github/ISSUE_TEMPLATE/feature_request.md). Time has shown that precise descriptions of your matter help speed up the problem resolution and avoid unnecessary confusion. + + +## Pull Requests + +Pull requests are a great way to get your ideas into this repository. + +When you create a pull request, please fill out the [pull request template](https://github.com/lxndrblz/anatole/blob/master/.github/PULL_REQUEST_TEMPLATE.md) and ensure your PR is well-tested and documented. + +When deciding if I merge a pull request, I look at the following things: +* Does it provide a clear benefit to other users (i. e. does it solve a clear problem) +* Does it follow Anatole's paramount goal of being a minimalistic and visually pleasant Hugo theme? In other words, make sure it does not bloat the theme. +* Is it of good quality? + +The Anatole repository ships with a prettier-config to ensure common code formatting criteria. Please run `npm run prettier` before submitting your PR, as this helps keep the formatting of the code consistent across the project. Let me know if you had trouble running prettier. + +## Thank You +Lastly, it is worth mentioning that this project would not be possible without contributors and supports like you. Even if you are not a programmer but still want to support the development, consider [sponsoring](https://ko-fi.com/lxndrblz) this project. \ No newline at end of file diff --git a/README.md b/README.md index bffa2cf..25c8eb7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Anatole  [](https://app.netlify.com/sites/anatole-demo/deploys) +# Anatole Hugo Theme  [](https://app.netlify.com/sites/anatole-demo/deploys) Anatole is a beautiful minimalist two-column [hugo](https://gohugo.io/) theme based on farbox-theme-Anatole. @@ -31,7 +31,7 @@ - Compliant to strict CSP - Post Series -## Preview the exampleSite +## Preview the Example Site ```shell git clone https://github.com/lxndrblz/anatole.git anatole @@ -53,6 +53,11 @@ This theme is maintained by its author [Alexander Bilz](https://github.com/lxndrblz) and with the help from these awesome [contributors](https://github.com/lxndrblz/anatole/graphs/contributors). Please open an issue/pull request if you want to contribute to making this theme better and more feature-complete. For PRs, please make sure that they align with the theme's goals: minimalism, speed, and elegance. +## Contributions +All contributions (including features, translations, code cleanups, improved documentation & bugs reporting) are welcome. + +Read the [guidelines](https://github.com/lxndrblz/anatole/blob/master/.github/CONTRIBUTING.md) for more information about contributing to this project. + ## Sponsoring If you like this theme, give it a star on GitHub, and consider supporting its development: -- Gitblit v1.10.0