Documentation for the Gopad project including the related tools and clients, you can find this website at gopad.eu.
The website is hosted on Netlify, the website gets
automatically updated on every push to the master branch.
We use mise to manage all required tools and their versions. Install it
by following the official installation instructions, then run
the following commands inside the repository to activate mise and install all
tools defined in mise.toml:
mise trust
mise installTo generate the website and serve it on localhost:1313
just execute this command and stop it with Ctrl+C:
npm install --ci
hugo serverWhen you are done with your changes just create a pull request, after merging the pull request the website will be updated automatically.
If you find a security issue please contact gopad@webhippie.de first.
Generally we are following conventional commits when we apply changes. That way we are able to generate proper changelogs for every release. Please use always pull requests to integrate new functionalities or to fix issues.
For the release process we are following semantic versioning which clearly indicates if a new version just resolves bugs, includes new features or even includes breaking changes.
After installing the tools via mise install as described above set up the
pre-commit hooks so they run automatically on every commit:
pre-commit install --hook-type pre-commit --hook-type commit-msg
pre-commitis managed by mise and will be available aftermise install.
If you have changed something on the source you should simply commit following the mentioned conventions:
git checkout -b feat/new-feature
git add --all
git commit -m 'feat: added awesome new feature'
git push --set-upstream origin feat/new-featureAfter pushing your changes into the Git repository you should create a pull request on GitHub. If the pull request have been merged and everything built fine it will also create automatically a new release at least once a week.
CC-BY-SA-4.0
Copyright (c) 2018 Thomas Boerger <thomas@webhippie.de>