README.md

Repository template

Caution

This project is no longer maintained.

⚠ This project is no longer maintained

This project is no longer maintained. In October 2023 I've created create-project, a CLI tool to interactively create a project. That project does the same as this template does, and way more, and therefore this project is being archived. I recommend using create-project instead.

---

A template for creating new repositories.

• Commit style using commitlint.
• Code formatting using Prettier.
• Version management using semantic-release.
• Dependency management using WhiteSource Renovate.

---

Table of contents

• Install
• Usage
• Documentation
• Contributing
• Security policy
• License

Install

This describes how to use this template, for which there are two options.

1. Create a new repository on GitHub and select vidavidorra/repo-template as Repository template.
2. Create a new empty repository on and merge this template.

   $ git commit --allow-empty -m 'chore: create HEAD'
   $ git remote add -t main upstream [email protected]:vidavidorra/repo-template.git
   $ export REPO_TEMPLATE_TAG="$(git -c 'versionsort.suffix=-' ls-remote --exit-code --refs --sort='version:refname' --tags upstream 'v*.*.*' | tail --lines=1 | cut --delimiter='/' --fields=3)"
   $ export REPO_TEMPLATE_COMMIT="$(git -c 'versionsort.suffix=-' ls-remote --exit-code --refs --sort='version:refname' --tags upstream 'v*.*.*' | tail --lines=1 | cut --characters=1-7)"
   $ git fetch --no-tags upstream tag "${REPO_TEMPLATE_TAG}"
   $ git merge --allow-unrelated-histories --squash "${REPO_TEMPLATE_TAG}"
   $ git commit --message "chore: initialise from vidavidorra/repo-template@${REPO_TEMPLATE_COMMIT} (${REPO_TEMPLATE_TAG})"
   $ git tag --delete "${REPO_TEMPLATE_TAG}"
   $ git remote remove upstream
   $ git push

Usage

Work through the checklist to setup the repository with this template.

Documentation

Please refer to the docs, for the documentation.

Contributing

Please create an issue if you have a bug report, feature proposal or question that does not yet exist.

Please give this project a star ⭐ if you like it and consider becoming a sponsor to support this project.

Please refer to the contributing guide detailed information about other contributions, like pull requests.

Security policy

Please refer to the Security Policy on GitHub for the security policy.

License

This project is licensed under the GPLv3 license.

Copyright © 2019-2022 Jeroen de Bruijn

License details.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

The full text of the license is available in the LICENSE file in this repository and online.