Repository readme.md file

README.md

Project Title

Short description of the project.

Branch	Build	Coverage	Environment
master			Stable
dev			Nightly

Overview

A more comprehensive explanation of the project, howtos, diagrams, etc.

              +-------------+
              |  Component  |
              |   Diagram   |
              +------+------+
                     |
       +-------------+-------------+
       |                           |
+------v------+             +------v------+
|   You can   |             |             |
|   create    |             |asciiflow.com|
|     it      |             |             |
+-------------+             +-------------+

Getting started

Infrastructure dependencies that needs to be installed before developing and running application on the machine:

• Database and version
• Runtime and SDKs

Building & running

Steps to perform in order to have a source code compiled on the machine.

Example

And then:

another example

End with an example of how to lunch application

Running the tests

Explain how to run unit/integration tests of the application all or one by one.

Debugging

Explain which IDEs can be used for debugging and how to configure. Should mention both - how to debug tests and how to debug application itself.

HOWTO

Explain how to add/modify building block (e.g. service, endpoint, domain model, etc.) of the application.

Deployment

Explanation how the application deployed, how CI/CD triggered, etc.

PULL_REQUEST_TEMPLATE.md

Description

Please include a summary of the change and which issue is fixed.

• If this a UI change, please add screenshots of what was added/changed.
• If there are configurations added/changed, please list them here.

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How has this been tested

Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration

• Unit tests
• Integration tests
• Manual tests
• Will be tested after deployment

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes