nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-23 07:47:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: first draft of contribution guidelines

Browse source
This commit is contained in:
Sören Weber 2021-08-30 22:30:00 +02:00
parent 9bc3f4e416
commit f1375dfe52
No known key found for this signature in database
GPG key ID: 07D17FF580AE7589
4 changed files with 66 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
.github/CONTRIBUTING.md vendored Normal file
View file

@ -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 <API 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 "" <tag>
git push origin <tag>
```
- 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 <tag>"
git push origin main
git tag --message "" --force <tag>
git push --force origin <tag>
```
- generate release with _gren_
```shell
npx github-release-notes@0.17.1 release --tags <tag>
```

4
README.md
View file

@ -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).

41
RELEASE.md
View file

@ -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 <API 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 "" <tag>
git push origin <tag>
```
- 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 <tag>"
git push origin main
git tag --message "" --force <tag>
git push --force origin <tag>
```
- Generate release with _gren_
```shell
npx github-release-notes@0.17.1 release --tags <tag>
```

2
exampleSite/content/_index.en.md
View file

@ -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