Merge pull request #38 from target/contributing

Create CONTRIBUTING and some templates

Author: colindean

.github/ISSUE_TEMPLATE/new_check.md

@@ -0,0 +1,28 @@
+---
+name: New check
+about: Suggest a new check
+title: 'New check:'
+labels: 'enhancement'
+assignees: ''
+
+---
+
+# What would you like to check?
+
+<!-- Provide as much detail as you can about what precisely you want to check. -->
+
+# What does the configuration look like?
+
+<!-- 
+Provide documentation of how you envision the configuration of the validator to function.  Please follow the style of other validators in the README, see https://github.com/target/data-validator#validators.
+Most of our rework requests are the result of an unclear vision for the interface to the check!
+-->
+
+# Are you going to work on it, or are you asking for it?
+
+- [ ] Asking
+- [ ] Working
+
+## If _working_ on it, when do you think you'll have a PR ready?
+
+<!-- Delete the previous header above if you're just asking for the check. -->

.github/PULL_REQUEST_TEMPLATE/new_check.md

@@ -0,0 +1,34 @@
+---
+name: New check
+about: Submit a new check
+title: 'New check:'
+labels: 'enhancement'
+assignees: ''
+
+---
+
+# What issue is this PR solving?
+
+<!-- Provide the link. -->
+
+# What does the configuration look like?
+
+<!-- 
+#### validatorName
+
+Provide a brief description of check and the condition that will result in a failure.  Document any arguments in the table below.
+ 
+| Arg | Type | Description |
+|-----|------|-------------| 
+-->
+
+# Have you completed all of these?
+
+- [ ] Add configuration documentation to the Validators section of the README.  You should be able to copy this from the previous section.
+- [ ] Pass the style checker requirements without warnings or errors (`sbt test` will not work without compliance!)
+- [ ] Does not modify any of the other validators. Please review the section Refactoring in the CONTRIBUTING.md.
+- [ ] Include tests. Submissions without tests will not be considered. Test the following things:
+     - [ ] Configuration parsing
+     - [ ] Configuration sanity checking
+     - [ ] Variable substitution
+     - [ ] Actual check functionality

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing to Data Validator
+
+## Fixing a bug you found
+
+1. Check existing [issues](https://github.com/target/data-validator/issues) first to see if anyone else has reported the bug
+2. Report the bug if no one else has reported it.
+3. Fix the bug.
+4. Submit a PR.
+5. Be ready for some back-and-forth between maintainers and you.
+
+## Creating new checks
+
+1. Check existing [issues](https://github.com/target/data-validator/issues) first to see if anyone else has reported a desire for the check.
+2. If it doesn't exist (it probably won't!) then create a new issue:
+    1. Provide an example of how you would like the configuration for the check to look. Most of our rework requests are the result of an unclear vision for the interface to the check!
+    2. Clearly state if you are intending to work on it or if you are simply asking for it. If you're going to work on it, please provide a timeline for delivery. If you're just asking for it, you're done after you've submitted the request issue.
+3. Work on it!
+    1. Abide by the style checker requirements.
+    2. Include tests. Submissions without tests will not be considered. Test the following things:
+        1. Configuration parsing
+        2. Configuration sanity checking
+        3. Variable substitution
+        4. Actual check functionality
+
+## Refactoring
+
+Follow the new checks procedure, but instead of providing a configuration example, clearly explain:
+
+1. How the current state of things negatively affects the extensibility of Data Validator.
+2. How you intend to remedy the situation with the minimum amount of code changed
+
+**Do not mix refactoring with the addition of a new check in the same pull request.** We will reject and ask that they be done in separate PRs to keep things manageable.