New GitHub repositories - HSLdevcom/jore4 GitHub Wiki
New GitHub repositories
When creating a new GitHub repository that is not a fork of another project, follow these steps:
- Prefix the name of the repository with
jore4-
. - Add the European Union Public License 1.2 (EUPL v1.2) as the file
LICENSE
in project root as your first commit, like here. - Add GitHub group
jore4
in role Admin like in jore4-ui access settings. - Configure the GitHub repository settings regarding available merges and protected branches as described in Code Review. FIXME: add example image of complete settings here and move the corresponding section in code review wiki page here
- Link the repository to the project backlog.
- In https://vincit.slack.com on channel
#jore-hsl-bots
, run:/github subscribe HSLdevcom/jore4-new-repository-name
/github unsubscribe HSLdevcom/jore4-new-repository-name commits
.
- If the repository is intended to build Docker images, ask the HSL DevOps team to create a Docker Hub repository with the same name as the GitHub repository. Provide the link to the GitHub repository to the HSL DevOps team as documentation. When the HSL DevOps team says the task is done, check that the Docker Hub credentials are available in the GitHub repository like they are in jore4-ui secrets settings.
When forking an existing project outside of Jore4:
- As with any dependency, check from the list that the license of the project to be forked is upstream-compatible with EUPL v1.2.
- Fork under
HSLdevcom
. - In most cases prefer the original repository name instead of
jore4-something
. - Do not change the license of the original project. This way our contributions may eventually swim upstream. That would reduce our maintenance burden and give back to the ecosystem.