Skip to content

Commit 1b1d36f

Browse files
committed
fix: adjusted README.md
1 parent 69cd52f commit 1b1d36f

File tree

1 file changed

+24
-13
lines changed

1 file changed

+24
-13
lines changed

README.md

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -32,39 +32,49 @@ Please check the links for more info, including usage information and full docum
3232
- [XOAP Website](https://xoap.io)
3333
- [XOAP Documentation](https://docs.xoap.io)
3434
- [Twitter](https://twitter.com/xoap_io)
35+
- [LinkedIn](https://www.linkedin.com/company/xoap_io)
3536

3637
---
3738

3839
## Guidelines
3940

40-
We are using the following guidelines to write code and make it easier for everyone to follow a destinctive guideline. Please check these links before starting to work on changes.
41+
We are using the following guidelines to write code and make it easier for everyone to follow a distinctive guideline.
42+
Please check these links before starting to work on changes.
4143

4244
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
4345

44-
Git Naming Conventions are an important part of the development process. They descrtibe how Branched, Commit Messages, Pull Requests and Tags should look like to make the easily understandebla for everybody in the development chain.
46+
Git Naming Conventions are an important part of the development process.
47+
They describe how Branches, Commit Messages,
48+
Pull Requests and Tags should look like to make them easily understandable for everybody in the development chain.
4549

4650
[Git Naming Conventions](https://namingconvention.org/git/)
4751

48-
he Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of.
52+
He Conventional Commits specification is a lightweight convention on top of commit messages.
53+
It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of.
4954

5055
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
5156

52-
The better a Pull Request description is, the better a review can understand and decide on how to review the changes. This improves implementation speed and reduces communication between the requester and the reviewer resulting in much less overhead.
57+
The better a Pull Request description is, the better a review can understand and decide on how to review the changes.
58+
This improves implementation speed and reduces communication between the requester,
59+
and the reviewer is resulting in much less overhead.
5360

54-
[Wiriting A Great Pull Request Description](https://www.pullrequest.com/blog/writing-a-great-pull-request-description/)
61+
[Writing A Great Pull Request Description](https://www.pullrequest.com/blog/writing-a-great-pull-request-description/)
5562

56-
Versioning is a crucial part for Terraform Stacks and Modules. Without version tags you cannot clearly create a stable environment and be sure that your latest changes won't crash your production environment (sure it still can happen, but we are trying our best to implement everything that we can to reduce the risk)
63+
Versioning is a crucial part for Terraform Stacks and Modules.
64+
Without version tags you cannot clearly create a stable environment
65+
and be sure that your latest changes will not crash your production environment (sure it still can happen,
66+
but we are trying our best to implement everything that we can to reduce the risk)
5767

5868
[Semantic Versioning](https://semver.org)
5969

60-
Naming Conventions for Terraform resources must be used.
61-
6270
[Terraform Naming Conventions](https://www.terraform-best-practices.com/naming)
6371

6472
---
6573

6674
## Share the Love
67-
Like this project? Please give it a ★ on [our GitHub](https://github.com/xoap-io/terraform-module-template)! It helps us a lot.
75+
Like this project?
76+
Please give it a ★ on [our GitHub](https://github.com/xoap-io/terraform-module-template)!
77+
It helps us a lot.
6878

6979
---
7080

@@ -94,10 +104,10 @@ PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
94104

95105
### Installation
96106

97-
For the first ime using this template necessary tools need to be installed.
98-
A script for PowerShell Core is provided under ./build/init.ps1
107+
For the first time using this template, necessary tools need to be installed.
108+
A script to prepare a Mac is provided under ./build/init.ps1
99109

100-
This script will install following dependencies:
110+
This script will install the following dependencies:
101111

102112
- [pre-commit](https://github.com/pre-commit/pre-commit)
103113
- [terraform-docs](https://github.com/terraform-docs/terraform-docs)
@@ -121,7 +131,8 @@ It currently supports the automated installation for macOS. Support for Windows
121131
### Synchronisation
122132

123133
We provided a script under ./build/sync_template.ps1 to fetch the latest changes from this template repository.
124-
Please be aware that this is mainly a copy operation which means all your current changes have to be committed first and after running the script you have to merge this changes into your codebase.
134+
Please be aware that this is mainly a copy operation which means all your current changes have to be committed first,
135+
and after running the script, you have to merge these changes into your codebase.
125136

126137
### Configuration
127138

0 commit comments

Comments
 (0)