diff --git a/BUG_REPORT_TEMPLATE.md b/BUG_REPORT_TEMPLATE.md new file mode 100644 index 0000000..796175e --- /dev/null +++ b/BUG_REPORT_TEMPLATE.md @@ -0,0 +1,37 @@ +# Console.Waterworks - Bug Report + +## Prerequisites + +Before submitting, please make sure your issue has not already been filed. You can do this at [GitHub Issues](https://github.com/craigoates/issues "GitHub Issues"). + +## Description + +[Description of the issue. Use images and GIFs if necessary.] + +## Steps to Reproduce + +[Use images and GIFs if necessary.] + +1. [First Step] +1. [Second Step] +1. [and so on...] + +## Expected Behaviour + +[What you expect to happen] + +## Actual Behaviour + +[What actually happens] + +## Reproduction Rate + +[What percentage of the time does it happen?] + +## Versions + +[You can get this information from using the Nuget Package Manager tools in Visual Studio/Project References.] + +## Additional Information + + [Any additional information, configuration or data that might be necessary to reproduce the issue.] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 517678c..a6c8d9a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to Console.Waterworks - Incomplete +# Contributing to Console.Waterworks (Incomplete) Let me begin by saying thank you for stopping by and checking out Console.Waterworks. diff --git a/Console.Waterworks/Console.Waterworks/Models/Command.cs b/Console.Waterworks/Console.Waterworks/Models/Command.cs index 66486ab..996517b 100644 --- a/Console.Waterworks/Console.Waterworks/Models/Command.cs +++ b/Console.Waterworks/Console.Waterworks/Models/Command.cs @@ -16,12 +16,13 @@ namespace Console.Waterworks.Models } /* - * Let us assume the end-user entered: [> Say "Hello, World!" 2] + * Let us assume the end-user entered: [> Say "Hello, World!" 2]. + * The input entered needs to be parse and seperated. + * This is so ClassName and Arguments can be set. * Once everything has been parsed, _arguments should look like the following, - * _arguments["Hello, World!", 2] (This is the "same" for Arguments) - * Once everything has been processed, ClassName will have been set as as well as Arguments. - * Using the example at the top of this comment block, the end result will look somethinglike, - * ClassName = "Say" | Arguments = ["Hello, World!", 2] + * _arguments["Hello, World!", "2"] (This will be "mirrored" in Arguments). + * Using the example at the top of this comment block, the end result will look something like, + * ClassName = "Say" | Arguments = ["Hello, World!", "2"] * This object will then be used as the guide to locate the command-method this model describes. */ public Command(string input, string commandsNamespace, string className) @@ -46,7 +47,7 @@ namespace Console.Waterworks.Models // This next part is a fancy feature and will almost never be used. if (splitCommandInput.Length == 2) { - // In short, it takes something like >TestClass1.TestMethod2 "Hello, World". + // In short, it takes something like [> TestClass1.TestMethod2 "Hello, World"]. // And, it isolates the "TestClass1" and TestMethod2" parts. ClassName = splitCommandInput[0]; // "TestClass1" Name = splitCommandInput[1]; // TestMethod2" @@ -58,7 +59,7 @@ namespace Console.Waterworks.Models var inputArgument = splitInput[splitInputLocation]; string argument = inputArgument; - // This bit is just a check to see if the input is a quoted string. + // This bit is just a check to see if the current part of the input is a quoted string. // If it is quoted text, "matches" will hold the various parts of the quote. var regex = new Regex("\"(.*?)\"", RegexOptions.Singleline); var matches = regex.Match(inputArgument); diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 063d201..9228fde 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1 +1,25 @@ -# Pull Request Templete - Incomplete +# Console.Waterworks - Pull Request + +## Requirements + +Filling out the template is required. Any pull request which does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion. + +## Description of the Change + +[TO DELETE] Aim to be as clear and concise as possible here. Use illustrations and gifs if you believe it will help explain your point. + +## Significant Design Changes + +[TO DELETE] If your pull request alters the design of the code in a significant manner, please state here what the changes are. If the changes are minor, feel free you include them in the description above. Do statement there is no major changes, though, for clarity. + +## Benefits + +[TO DELETE] List out the benefits. Aim to keep them short and to the point. + +## Possible (Immediate) Drawbacks + +[TO DELETE] List out any drawbacks your pull request introduces to the project. If you feel is necessary, elaborate as much as you can to help explain the drawbacks with accepting the pull request. + +## Foreseen Issues + +[TO DELETE] If you can foresee a problem **beyond** this pull request, use this section to highlight them. This will help determine the steps beyond the pull request, if any need to be taken. \ No newline at end of file diff --git a/README.md b/README.md index e98dbfa..4acb53a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Console.Waterworks - This is incomplete +# Console.Waterworks - ReadMe (This is incomplete) Console.Waterworks is a Nuget package. It aims to help you write extendable and command-based console programs in C# and .Net. One of the main struggles with writing software is the need to write "plumbing code". It is the code which does not solve the main problem but it is necessary for us to reach a solution. This is why we all feel frustrated when we need to write it. It feels like we are going the long way round to that dream holiday in the sun. This is why I created Console.Waterworks. I believe we should face frustration when it finds us and only then. Why go looking for it?