|
|
||
|---|---|---|
| .gitea | ||
| docs | ||
| project_name | ||
| project_name.Tests | ||
| .gitignore | ||
| Containerfile | ||
| CONTRIBUTING.md | ||
| HISTORY.md | ||
| LICENSE | ||
| Makefile | ||
| MANIFEST.in | ||
| mkdocs.yml | ||
| project_name.sln | ||
| README.md | ||
Dotnet Project Template
A low dependency and really simple to start project template for Python Projects.
See also
- Dotnet-Library-Template for a library template.
HOW TO USE THIS TEMPLATE
- Create a new repository from this template and choose a name for your project
(e.g.
my_awesome_project- recommendation is to use all lowercase and underscores separation for repo names.) - Wait until the first run of CI finishes (Gitea Actions will process the template and commit to your new repo)
- Read the file CONTRIBUTING.md
- Then clone your new project and happy coding!
Note
: WAIT until first CI run on gitea actions before cloning your new project.
What is included on this template?
- 🖼️ Templates for starting multiple application types:
Run
make initafter cloning to generate a new project based on a template. - 🤖 A Makefile with the most useful commands to install, test, lint, format and release your project.
- 📃 Documentation structure using mkdocs
- 💬 Auto generation of change log using gitchangelog to keep a HISTORY.md file automatically based on your commit history on every release.
- 🐋 A simple Containerfile to build a container image for your project.
Containerfileis a more open standard for building container images than Dockerfile, you can use buildah or docker with this file. - 🧪 Testing structure
- ✅ Code linting
- 🎯 Entry points to execute your program with basic CLI argument parsing.
- 🔄 Continuous integration using Gitea Actions with jobs to lint, test and release your project on Linux, Mac and Windows environments.
project_name
project_description
Usage
TODO: dotnet sample code on usage
Development
Read the CONTRIBUTING.md file.