kiote · May 13, 2021 11:18 · May 13, 2021
diff --git a/templat.md b/templat.md
@@ -0,0 +1,37 @@
+## How to write readmes for your projects
+
+"Your" project is a project you happen to make any changes at.
+Any Readme can contain also extra parts, specific for a project.
+
+## Necessary parts 
+
+Underneath is a template you can use in a project without any (or with scaffolded) readme:
+
+### Intro
+
+What this project is about, what problem it solves. General description.
+
+### Setup
+
+How to run project locally
+
+### Contribution
+
+How bug fixes are named? How feature-branches are named? 
+Where pull requests should go (straight to master, develop branch)?
+
+### Deployment
+
+How to deploy project
+
+### Useful URLs for testing 
+
+How to test project (URLs in different envs should go here)
+
+### Alerting, monitoring, logging
+
+If project has some specific alerts, monitoring dashboards or logs, put it here
+
+### Related repos
+
+If project directly relates to some other projects, put links here
No results found