Following the steps you should perform after cloning this template repository:
-
execute init.sh
-
adjust/check the TODO in this file
-
add a new discussion category
Contributor Q&A
--Ask other contributors for help
-
in order that the tegonal-bot pushes changes to its own fork (e.g. when executing cleanup.yml or gt-update.yml -- see below for an explanation) and then create a normal PR you need to:
- add the repository variable
AUTO_PR_FORK_NAME
with value tegonal-bot/PROJECT_NAME_GITHUB - login as tegonal-bot and then fork the repository
- add the repository variable
-
Following a short introduction in the scripts already setup in this repository:
- before-pr.sh is executed in .github/workflows/quality-assurance.yml
it currently executes scripts/cleanup-on-push-to-main.sh and scripts/run-shellcheck.sh
and should be extended by project specific tasks such as
sbt versionPolicyCheck
(e.g. in a scala project) - cleanup-on-push-to-main.sh is executed in .github/workflows/cleanup.yml and is meant to cleanup after a PR. => put commands such as code formatting in it, code generation which is committed etc.
- run-shellcheck.sh checks that shellcheck doesn't find issues in scripts located in the scripts directory
- before-pr.sh is executed in .github/workflows/quality-assurance.yml
it currently executes scripts/cleanup-on-push-to-main.sh and scripts/run-shellcheck.sh
and should be extended by project specific tasks such as
-
Following a short introduction in the workflows already setup in this repository:
- cleanup.yml => run after push on main and intended to cleanup after a PR.
- gt-update.yml => run periodically, updates all files pulled in via gt
- quality-assurance.yml => run for PR and pushes, checks that the code/script quality and such are ok and no TODOs are left open => you will typically add more jobs which run tests (sbt test or gradle build)
-
git commit -a -m "initialised"
-
As last step, delete this section and you are ready to start with your new OSS project
TODO
❗ You are taking a sneak peek at the next version. It could be that some features you find on this page are not
released yet.
Please have a look at the README of the corresponding release/git tag. Latest
version: README of v0.1.0.
Table of Content
TODO PROJECT_NAME is published to maven central.
TODO Code documentation can be found on github-pages: https://ORG_NAME_GITHUB.github.io/PROJECT_NAME_GITHUB.
Our thanks go to code contributors as well as all other contributors (e.g. bug reporters, feature request creators etc.)
You are more than welcome to contribute as well:
- star this repository if you like/use it
- open a bug if you find one
- Open a new discussion if you are missing a feature
- ask a question so that we better understand where we can improve.
- have a look at the help wanted issues.
Please have a look at CONTRIBUTING.md for further suggestions and guidelines.
PROJECT_NAME is licensed under LICENSE_LINK