A repository template for common open-source project standardization (README, CONTRIBUTING, GitHub templates, etc).
I found sometimes it's hard to start a project especially for single developers or small organizations. It is tired even just writing documentations, configurations and workflows. Fortunately, there are much similar works in many projects. So I include most of essential files that basically requires a simple open project's needs. Then, we can just clone this repository as a starting template when we want to create a new project, which simplifies the project starting process wasting time in past.
We hope this template enables you to write better documentation for your own projects! Any contributions are welcome from all.
There are few ways to use this template. e.g.:
- Click the button Use this template on GitHub to create a new repository directly.
- With Yoeman.
Any contributing including bug reports, proposals and pull requests is welcomed!
-
Bump version with Standard Version
- with first release, run:
npm run release -- --first-release - with pre-release, run:
npm run release -- --prerelease [alpha|beta|rc|stable] - with version bump, run:
npm run release -- --release-as [major|minor|patch]
- with first release, run:
For more on project documentation: