Skip to content

Instantly share code, notes, and snippets.

@arthursvpb

arthursvpb/README.md

Created January 31, 2023 18:04
Show Gist options
  • Save arthursvpb/b90456a5fa8f4be4b510ab9274cc8a0f to your computer and use it in GitHub Desktop.
Save arthursvpb/b90456a5fa8f4be4b510ab9274cc8a0f to your computer and use it in GitHub Desktop.
Download ZIP
Readme Template
Raw
README.md

Project name

Project description

Documentation • Prerequisites • Execution • Tests • CI/CD • Monitoring • Technologies • Contributors

Documentation

Useful links to external documentation (eg: Confluence).

Prerequisites

Dependencies needed for the project to run locally.

Execution

Step by step to execute the project.

Tests

Step by step to run the project tests.

CI/CD

Where CI/CD pipelines can be found (Eg: Jenkins).

Monitoring

Where monitoring can be viewed (Eg: NewRelic, Grafana, Cloudwatch).

Technologies

Technologies used to build the project.

Contributors

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment