From f1375dfe52f5f9b9c2c0b9fd1ee38ab52387fb5a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Weber?= Date: Mon, 30 Aug 2021 22:30:00 +0200 Subject: [PATCH] docs: first draft of contribution guidelines --- .github/CONTRIBUTING.md | 61 ++++++++++++++++++++++++++++++++ README.md | 4 +++ RELEASE.md | 41 --------------------- exampleSite/content/_index.en.md | 2 +- 4 files changed, 66 insertions(+), 42 deletions(-) create mode 100644 .github/CONTRIBUTING.md delete mode 100644 RELEASE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000000..c1e3673ae1 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,61 @@ +# Guidelines + +## For Development + +- help us putting your code into production by opening a meaningful issue +- stay simple for the user by focusing on the mantra "convention over configuration" +- at installation the site should work reasonable without (m)any configuration +- stay close to the Hugo way +- don't use npm or any preprocessing, our contributors may not be front-end developers +- document new features in exampleSite +- don't break existing features if you don't have to +- remove reported issue from the browser's console +- be compatible to IE11, at least for main functionality, for Javascript this means: + - test in IE11 + - check caniuse.com + - don't use arrow functions + - don't use template literals + - don't use other fancy new ES5/6 stuff + +## For Release + +- create releases following [semver policy](https://semver.org/) +- we are using [gren](https://github.com/github-tools/github-release-notes) to generate the changelog and releases + +### One Time Steps + +- Generate API Token as described in [gren's README.md](https://github.com/github-tools/github-release-notes) +- On Windows do `setx GREN_GITHUB_TOKEN ` and restart your shell + +### Steps per Release + +- close all issues of the milestone or push them back to an open milestone +- close the milestone +- Tag and push the repo + + ```shell + git tag --message "" + git push origin + ``` + +- regenerate changelog with _gren_ + + ```shell + npx github-release-notes@0.17.1 changelog --generate --override --tags=all + ``` + +- add the changelog to git and update the tag + + ```shell + git add exampleSite/content/basics/CHANGELOG.md + git commit --message "Ship tag " + git push origin main + git tag --message "" --force + git push --force origin + ``` + +- generate release with _gren_ + + ```shell + npx github-release-notes@0.17.1 release --tags + ``` diff --git a/README.md b/README.md index 7f95922429..739f894765 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,10 @@ Visit the [documentation](https://relearn.netlify.app/) to learn about all avail See the [changelog](https://relearn.netlify.app/basics/history) for a complete list of releases. +## Contribution + +You are most welcome to contribute to the source code but please visit the [contribution guidelines](https://github.com/McShelby/hugo-theme-relearn/blob/main/.github/CONTRIBUTING.md) first. + ## License This theme is licensed under the [MIT License](https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE). diff --git a/RELEASE.md b/RELEASE.md deleted file mode 100644 index a233a0bf3b..0000000000 --- a/RELEASE.md +++ /dev/null @@ -1,41 +0,0 @@ -# Releasing - -We are using [gren](https://github.com/github-tools/github-release-notes) to generate the changelog and release notes automatically. - -## Once: - -- Generate API Token as described in [gren's README.md](https://github.com/github-tools/github-release-notes) -- On Windows do `setx GREN_GITHUB_TOKEN ` and restart your shell - -## Per release: - -- Close all issues of the milestone or push them back to an open milestone -- Close the milestone -- Tag and push the repo - - ```shell - git tag --message "" - git push origin - ``` - -- Regenerate CHANGELOG.md with _gren_ - - ```shell - npx github-release-notes@0.17.1 changelog --generate --override --tags=all - ``` - -- Add the changelog to git and update the tag - - ```shell - git add exampleSite/content/basics/CHANGELOG.md - git commit --message "Ship tag " - git push origin main - git tag --message "" --force - git push --force origin - ``` - -- Generate release with _gren_ - - ```shell - npx github-release-notes@0.17.1 release --tags - ``` diff --git a/exampleSite/content/_index.en.md b/exampleSite/content/_index.en.md index c83067a64d..0c12869da7 100644 --- a/exampleSite/content/_index.en.md +++ b/exampleSite/content/_index.en.md @@ -37,7 +37,7 @@ To get support, feel free to open a new [discussion topic](https://github.com/Mc Feel free to update this documentation by just clicking the **Edit this page** link displayed on top right of each page. Your changes will be deployed automatically once they were reviewed. -You are most welcome to contribute bugfixes or even new features to the source code by making pull requests to the [official repository](https://github.com/McShelby/hugo-theme-relearn) via GitHub. +You are most welcome to contribute bugfixes or even new features to the source code by making pull requests to the [official repository](https://github.com/McShelby/hugo-theme-relearn) via GitHub. Please visit the [contribution guidelines](https://github.com/McShelby/hugo-theme-relearn/blob/main/.github/CONTRIBUTING.md) first. ## License