@ -10,13 +10,13 @@ The following is a set of guidelines for contributing to Console.Waterworks. I m
### Code of Conduct
The [Console.Waterworks Code of Conduct](https://github.com/CraigOates/Console.Waterworks/blob/develop/CODE_OF_CONDUCT.md, "Code of Conduct") governs every participant of this project. If you decide to take part in developing and cultivating the project, the expectation is you adhere to it.
The [Console.Waterworks Code of Conduct](https://github.com/CraigOates/Console.Waterworks/blob/develop/CODE_OF_CONDUCT.md "Code of Conduct") governs every participant of this project. If you decide to take part in developing and cultivating the project, the expectation is you adhere to it.
Please report any unacceptable behaviour to [craig@craigoates.net](craig@craigoates.net, "Craig's email address").
Please report any unacceptable behaviour to craig@craigoates.net.
### The Creator's Expectations for Console.Waterworks
To those who do not know, Console.Waterworks is the creation of Craig Oates (A.K.A. [me](http:github.com/CraigOates, "Craig's GitHub Profile")). I am a person, like you, and I argue it is important you know a bit about me. The reason why this is important is because it will help you gauge if this project is for you. I do not want you to feel frustrated when working on Console.Waterworks due to people problems. I know I cannot foresee every problem and counteract it. But, I can let you know the type of person I am and what I expect from the project. This will help you gauge the likelihood of us having conflicting personalities. And, it will highlight any differences in perspectives sooner -- if all goes as intended.
To those who do not know, Console.Waterworks is the creation of Craig Oates (A.K.A. [me](http:github.com/CraigOates "Craig's GitHub Profile")). I am a person, like you, and I argue it is important you know a bit about me. The reason why this is important is because it will help you gauge if this project is for you. I do not want you to feel frustrated when working on Console.Waterworks due to people problems. I know I cannot foresee every problem and counteract it. But, I can let you know the type of person I am and what I expect from the project. This will help you gauge the likelihood of us having conflicting personalities. And, it will highlight any differences in perspectives sooner -- if all goes as intended.
If it does look like we have a miss-match at the person level, I would like to take a moment and say one thing. It is okay -- we do not all think alike. You will face no hard feelings from me and I have no problem with you forking the code. If you do, I wish you the best of luck. And, do not feel like you cannot contact me and show me your weird and wonderful concoction.
@ -28,31 +28,31 @@ Before moving on, I would like to reiterate a point from above. You will not rec
### "I don't want to read this, I want to ask a quick question"
The easiest and faster way to contact me is via email. Which is [craig@craigoates.net](craig@craigoates.net, "Craig's email address"). I do not recommend filling an issue because of this.
The easiest and faster way to contact me is via email. Which is craig@craigoates.net. I do not recommend filling an issue because of this.
### "What Should I Know Before I Get Started?"
Before you jump in, I recommend you read [The Complete Guide to Console.Waterworks](https://github.com/craigoates, "C.W. Complete Guide"). Console.Waterworks is not the most expansive or complex piece of code on the planet. But, it does have its own quirks and behaviours. I have tried to make it as modular and as easy to read as possible. But, it still has a reasonable amount of complexity to it. So, please read the guide.
Before you jump in, I recommend you read [The Complete Guide to Console.Waterworks](https://github.com/craigoates "C.W. Complete Guide"). Console.Waterworks is not the most expansive or complex piece of code on the planet. But, it does have its own quirks and behaviours. I have tried to make it as modular and as easy to read as possible. But, it still has a reasonable amount of complexity to it. So, please read the guide.
### "How Can I Contribute?"
You can contribute to the project in several ways. The obvious two ways are [filing issues](https://github.com/CraigOates/Console.Waterworks/issues/new, "C.W. Issues") and sending [pull requests](https://github.com/CraigOates/Console.Waterworks/compare, "C.W. Pull request"). You can, also, contribute by sending me an email. Although, the last one is not as open as the previous two. It is still an effective route to take if you want to discuss something at length. My email address is [craig@craigoates.net](craig@craigoates.net, "Craig's email address").
You can contribute to the project in several ways. The obvious two ways are [filing issues](https://github.com/CraigOates/Console.Waterworks/issues/new "C.W. Issues") and sending [pull requests](https://github.com/CraigOates/Console.Waterworks/compare "C.W. Pull request"). You can, also, contribute by sending me an email. Although, the last one is not as open as the previous two. It is still an effective route to take if you want to discuss something at length. My email address is craig@craigoates.net.
#### Reporting Bugs
I track bugs using [GitHub Issues](https://github.com/CraigOates/Console.Waterworks/issues/new, "C.W. Issues"). If you find one, fill out the template provided and file an issue.
I track bugs using [GitHub Issues](https://github.com/CraigOates/Console.Waterworks/issues/new "C.W. Issues"). If you find one, fill out the template provided and file an issue.
When you file a bug report, do not hold back with the details. The more information I have, the chance of me fixing it increases.
#### Suggesting Enhancements
You might have read [The Creator's Expectations](https://github.com/CraigOates/Console.Waterworks/blob/develop/CONTRIBUTING.md#the-creators-expectations-for-consolewaterworks, "Creator's Expections Section") above... If you have, you will know I hold a conservative attitude for adding features. With that said, I am not against adding new features -- stated above as well. If you believe your suggestion has some merit, please feel free to submit it. I am more than happy to discuss your plan. Please, do not feel offended if your suggestion does not get added to the project, though. That is not my intension.
You might have read [The Creator's Expectations](https://github.com/CraigOates/Console.Waterworks/blob/develop/CONTRIBUTING.md#the-creators-expectations-for-consolewaterworks "Creator's Expections Section") above... If you have, you will know I hold a conservative attitude for adding features. With that said, I am not against adding new features -- stated above as well. If you believe your suggestion has some merit, please feel free to submit it. I am more than happy to discuss your plan. Please, do not feel offended if your suggestion does not get added to the project, though. That is not my intension.
#### "How do I Submit an Enhancement Suggestion?"
You can submit an enhancement suggestion via [GitHub Issues](https://github.com/CraigOates/Console.Waterworks/issues/new, "C.W. Issues"). Before you do, here is a list of things to consider when submitting an enhancement suggestion.
You can submit an enhancement suggestion via [GitHub Issues](https://github.com/CraigOates/Console.Waterworks/issues/new "C.W. Issues"). Before you do, here is a list of things to consider when submitting an enhancement suggestion.
- Use a clear and descriptive title for the issue to help identify the suggestion.
- Describe your enhancement in a brief summary. Aim to be as clear as possible.
@ -61,7 +61,7 @@ You can submit an enhancement suggestion via [GitHub Issues](https://github.com/
- If you have any step-by-step instructions, include them.
- Include any code snippets you think will help explain your points better. You can provide either links to an external source or include them as markdown blocks.
- Include screenshots and animated GIFs. They will help me understand your proposal better. It will, also, help explain where it will fit into Console.Waterworks.
- You can use [Licecap](https://github.com/justinfrankel/licecap, "LiceCap GitHub Repository") to help you record GIFs. It is available on Windows and MacOS. If you are on Linux, you can use [Silentcast](https://github.com/colinkeenan/silentcast, "SilentCast GitHub Repository") or [Byzanz](http://github.com/gnome/byzanz, "Byzanz GitHub Repository"). They are, also, GIF recording programs.
- You can use [Licecap](https://github.com/justinfrankel/licecap "LiceCap GitHub Repository") to help you record GIFs. It is available on Windows and MacOS. If you are on Linux, you can use [Silentcast](https://github.com/colinkeenan/silentcast "SilentCast GitHub Repository") or [Byzanz](http://github.com/gnome/byzanz, "Byzanz GitHub Repository"). They are, also, GIF recording programs.
- Explain why this suggestion will be useful for most consumers of Console.Waterworks. I ask you to do this because it is one thing to work on Console.Waterworks and another to use it as a Nuget package.
- List any other examples of your suggestion in a working context. Also, highlight the benefit it has brought to that codebase.
@ -69,13 +69,13 @@ I have decided not to include a template here because writing proposals can be a
#### Pull Requests
Before submitting a pull request, I must stress the importance of talking to me first. I do not want you spending hours of your time writing code for Console.Waterworks to then face rejection. Your time is not my time and I would like to avoid wasting either of ours if I can help it. If there is something you would like to add to Console.Waterworks, you can do two things. The first is [email me](craig@craigoates.net, "Craig's email address") and talk about your plans. This is the quickest way for you to find out if your idea is worth pursuing. The second thing you can do is send an [enhancement suggestion](https://github.com/CraigOates/Console.Waterworks/issues/new, "C.W. Issues") via GitHub Issues and hold the discussion there. This will result in a slower response but the conversation will be in the open. If you decide to file a suggestion, make sure you have read "Suggesting Enhancements", above.
Before submitting a pull request, I must stress the importance of talking to me first. I do not want you spending hours of your time writing code for Console.Waterworks to then face rejection. Your time is not my time and I would like to avoid wasting either of ours if I can help it. If there is something you would like to add to Console.Waterworks, you can do two things. The first is email me (craig@craigoates.net) and talk about your plans. This is the quickest way for you to find out if your idea is worth pursuing. The second thing you can do is send an [enhancement suggestion](https://github.com/CraigOates/Console.Waterworks/issues/new "C.W. Issues") via GitHub Issues and hold the discussion there. This will result in a slower response but the conversation will be in the open. If you decide to file a suggestion, make sure you have read "Suggesting Enhancements", above.
Now back to the pull requests...
Here is a list of things to consider when submitting a pull request:
- Fill in the [Pull Requests Template](https://github.com/CraigOates/Console.Waterworks//blob/develop/PULL_REQUEST_TEMPLATE.md, "C.W. Pull request")
- Fill in the [Pull Requests Template](https://github.com/CraigOates/Console.Waterworks//blob/develop/PULL_REQUEST_TEMPLATE.md "C.W. Pull request")
- Do not include issue numbers in the pull request title.
- Include screenshots and animated GIFs in your pull request whenever possible.
- Follow the C# and Code Comments style guides.
@ -101,8 +101,8 @@ Aim to adhere to the standard C# coding conventions. If you are working in Visua
I have tried to reduce the inclusion of comments to public facing and "messy" code. This is due -- for the most part -- to intelliSense. It provides the user of Console.Waterworks with help when wiring it up to their console program. With that said, what makes sense to me does not mean it does for you. So, if you feel like something needs further explanation, please add a comment. I would prefer it is comments aimed to explain the "why" and not the "how" or "what". But, this preference is a starting point and not an absolute. If you add a comment, please use XML-Comments for public code and standard comments for private code. I am not fussed if you use one multi-line comment or several inline ones.
### Code Example - Bad Input
### Disclaimer
Console.Waterworks is based on the [ConsoleApplicationBase](https://github.com/TypecastException/ConsoleApplicationBase, "ConsoleApplicationBase GitHub Repository") repository by [TypecastException](https://github.com/TypecastException, "TypecastException's GitHub Profile").
Console.Waterworks is based on the [ConsoleApplicationBase](https://github.com/TypecastException/ConsoleApplicationBase "ConsoleApplicationBase GitHub Repository") repository by [TypecastException](https://github.com/TypecastException "TypecastException's GitHub Profile").
### Pre-Requisites
To use Console.Waterworks, I recommend you meet the following pre-requisites:
- You have experience with [C#](https://docs.microsoft.com/en-us/dotnet/csharp/, "C# Documentation").
- You can create a [.Net console program](http://www.com, "Console program tutorial") in [Visual Studio 2017](https://www.visualstudio.com/vs/, "Visual Studio 2017 Info.").
- You have experience with [Nuget](https://www.nuget.org/, "Nuget's website").
- You have Microsoft [.Net Framework 4.7](https://docs.microsoft.com/en-us/dotnet/framework/install/guide-for-developers, ".Net Framework download") or higher.
- You have experience with [C#](https://docs.microsoft.com/en-us/dotnet/csharp/ "C# Documentation").
- You can create a [.Net console program](http://www.com "Console program tutorial") in [Visual Studio 2017](https://www.visualstudio.com/vs/ "Visual Studio 2017 Info.").
- You have experience with [Nuget](https://www.nuget.org/ "Nuget's website").
- You have Microsoft [.Net Framework 4.7](https://docs.microsoft.com/en-us/dotnet/framework/install/guide-for-developers ".Net Framework download") or higher.
### Quick Start - Wiring Console.Waterworks in to your Console Program
@ -100,7 +100,7 @@ Both of these guides are printer friendly. And, they are best consumed on your f
For those sitting at their computer and connected to the world-wide web, there is a Wiki:
