Skip to content
/ GitHubBoilerplate Public template

The plug and play project template all open source projects should be based upon. Checkout for more.

License

Notifications You must be signed in to change notification settings

Witteborn/GitHubBoilerplate

Repository files navigation

screenshot

Description

Creating and maintaining a project aint easy. I found myself setting up multiple projects wit a similar structure until I made use of GitHub-Templates. Setting up a project should take no more than a few minutes max and come with all features a modern project needs. I used this template a lot privately until some friends asked me to publish it. So here it is free to use under the MIT-License.

If you like this project please star it and share it with others.

Features

  • Easy to build uppon DevOps workflows
  • Automated Release drafts with changelogs based on issues thanks to GitReleaseManager
  • A great variety of issue templates
  • A Pull request template
  • A README file with all you need
  • Automated Semantic Versioning thanks to GitVersion
  • A funding file to easily enable sponsorships in your repository

Installation

Click on "Use Template" to create a repository based on this one. The new repository will contain all files and therefor all workflows, templates and assets.

It is recommended to update the .gitignore based on your project you will use this for.

Dont forget to change the LICENSE.

Unfortunately GitHub does not yet offer the possibility to transfer labels automatically, so if you want to use the same ones then please transfer them manually from here

Usage

Using this template is fairly trivial. You might want to know about how to use certain modules/features of this template.

For more information on how to use GitReleaseManager please checkout their documentation.

Contribution

Pull request are very welcome, please open an issue in advance.

Please check out our Contribution Guidelines and Code of Conduct before creating a pull request.

Support

If you need any help check out our Support file.

Security

Have you found a security issue? a vulnerability? or simply have some concerns? Checkout our Security file to see how you can report them safely.

Thank you

Cake for being a rolemodel in this project and providing us with various templates.

GitReleaseManager for helping us to create easy release drafts

GitVersion for helping us to automatically generate a SemVer in our workflow

ReactBoilerplate for providing us with fresh ideas and being an inspiration for this project.

Also thank you to all contributors, people who open issues and bring in new ideas and feedback and anyone who shares this project and helps us in anyway possible. Thank you! without you this wouldn't be possible.

About

The plug and play project template all open source projects should be based upon. Checkout for more.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks