repo-template

A template for creating new repositories.

Badges
Setup
Checklist
License

Badges

Badge	Description	Service
	Code style	Prettier
	Commit style	Conventional Commits
	Lint commit messages	GitHub Actions
	Lint	GitHub Actions

Setup

After a new repository using this template has been created, make the .

Create a temporary checklist and replace the readme with the example.
```
$ mv README.md CHECKLIST.md
$ mv README.example.md README.md
```
Go through the checklist.
Remove the temporary checklist.
```
$ rm CHECKLIST.md
```

Checklist

Go through this checklist after creating your repository. It should only take a couple of minutes.

README.md

Is the <title> field correct?
Is the <description> field correct?
Are the <repo-name> fields correct?
Is the date (range) of the license correct?

Package.json

Is the name field correct?
Is the description field correct?
Is the version field correct? Use npm version 0.1.0 --git-tag-version=false to set the version, 0.1.0 in this example.
Is the author field correct?
Have you added keywords?
Are the repository.url, bugs and homepage links correct?

Language setup

Typescript

Is there a tsconfig.json file? See vidavidorra/next-standard-version for an example of the file.

License

This project is licensed under the GPLv3 license.

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.

4 KiB Raw Blame History