-
Notifications
You must be signed in to change notification settings - Fork 9
Contribution Guidelines
Welcome to the guidelines to working with the Daybreak factions. Consider all of the following points requests and recommendations.
Code style is always an explosive topic. People tend to not agree on styles, because different options provide different benefits, that depending on your context make more sense or not. Since we are the daybreak faction, having a consistent style across the entire project would be great, as it fits with our theme.
Thus there was a vote on what style to use. This does not constitute concession on one style's superiority over the other (the votes were really close!), but rather a compromise for a short term collaboration.
The official brace style for this event is like this:
if ($foo) {
"Foo"
} else {
"Bar"
}The official indentation style is to use 4 whitespaces per indentation level. In the entire project there shall not be a single tab.
The module being created requires the modulke PSFramework. You can install it from the gallery by running this command:
Install-Module PSFramework
Your code contribution does not need to use it, but the test suite depends on it, as may other features. Installing it will allow you the most leeway in testing your code. The sole author of this module is @FriedrichWeinmann who is present on the conference. In the slack channels he is known as fred. If you have any questions or doubts about this module, feel very free to contact him directly.
Fred will be assisting with tools and templates. To fully be able to utilize them, the following modules are recommended (but not required to work on the tasks set forth by the competition!):
PSModuleDevelopment
PSUtil
The repository will soon contain a module named Daybreak2018Tools. This module is designed to provide tools to work on the tasks.
PLease try to clone the repository on your local computer and have the tools ready in time for the competition.