You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-11
Original file line number
Diff line number
Diff line change
@@ -17,9 +17,9 @@
17
17
18
18
## Introduction
19
19
20
-
This is the XOAP PowerShell DSC configuration repository.
20
+
This is the [XOAP](https://xoap.io) PowerShell DSC configuration repository.
21
21
22
-
It is part of our XOAP Automation Forces Open Source community library to give you a quick start into Infrastructure as Code deployments with PowerShell DSC in addition to config.XO.
22
+
It is part of our [XOAP](https://xoap.io) Automation Forces Open Source community library to give you a quick start into Infrastructure as Code deployments with PowerShell DSC in addition to config.XO.
23
23
24
24
Please check the links for more info, including usage information and full documentation:
25
25
@@ -32,43 +32,52 @@ Please check the links for more info, including usage information and full docum
32
32
33
33
## Disclaimer
34
34
35
-
**All configurations are provided AS IS. We are not responsible for anything that happens inside your environment because you applied the configurations and didn´t test them thoroughly before doing so.**
35
+
**All configurations are provided AS IS. We are not responsible for anything that happens inside your environment because you applied the configurations and did not test them thoroughly before doing so.**
36
36
37
37
Be sure to always test any of those configurations in separated test environment and test clients and servers.
38
38
39
-
>Some of the available DSC configurations make severe changes to securityrelated configurations and could leave your Windows operating system in an unusable state.
39
+
>Some of the available DSC configurations make severe changes to security-related configurations and could leave your Windows operating system in an unusable state.
40
40
41
41
So please test once, twice or trice.
42
42
43
43
---
44
44
45
45
## Guidelines
46
46
47
-
We are using the following guidelines to write code and make it easier for everyone to follow a distinctive guideline. Please check these links before starting to work on changes.
47
+
We are using the following guidelines to write code and make it easier for everyone to follow a distinctive guideline.
48
+
Please check these links before starting to work on changes.
Git Naming Conventions are an important part of the development process. They describe how Branches, Commit Messages, Pull Requests and Tags should look like to make the easily understandable for everybody in the development chain.
52
+
Git Naming Conventions are an important part of the development process.
53
+
They describe how Branches, Commit Messages,
54
+
Pull Requests and Tags should look like to make them easily understandable for everybody in the development chain.
The 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.
58
+
He Conventional Commits specification is a lightweight convention on top of commit messages.
59
+
It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of.
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.
63
+
The better a Pull Request description is, the better a review can understand and decide on how to review the changes.
64
+
This improves implementation speed and reduces communication between the requester,
65
+
and the reviewer is resulting in much less overhead.
60
66
61
67
[Writing A Great Pull Request Description](https://www.pullrequest.com/blog/writing-a-great-pull-request-description/)
62
68
63
-
Versioning is a crucial part of everything as code. Without version tags, you cannot clearly create a stable environment
64
-
and be sure that your latest changes will not 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).
69
+
Versioning is a crucial part for Terraform Stacks and Modules.
70
+
Without version tags you cannot clearly create a stable environment
71
+
and be sure that your latest changes will not crash your production environment (sure it still can happen,
72
+
but we are trying our best to implement everything that we can to reduce the risk)
65
73
66
74
[Semantic Versioning](https://semver.org)
67
75
68
76
---
69
77
70
78
## Share the Love
71
-
Like this project? Please give it a ★ on [our GitHub](https://github.com/xoap-io/xoap-powershell-dsc-configurations)!
79
+
Like this project?
80
+
Please give it a ★ on [our GitHub](https://github.com/xoap-io/xoap-powershell-dsc-configurations)!
0 commit comments