Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nischi committed Jul 1, 2019
1 parent 68f1601 commit 6ab42ad
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,34 @@
Contribution Policy for MMM-Face-Reco-DNN
====================================

Thanks for contributing to MMM-Face-Reco-DNN.

We hold our code to standard, and these standards are documented below.

### Clean Code

Please only submit clean code with correct formatting and good Variable Names.

### Submitting Issues

Please only submit reproducible issues.

When submitting a new issue, please supply the following information:

**Platform**: Place your platform here... give us your web browser/Electron version *and* your hardware (Raspberry Pi 2/3, Windows, Mac, Linux, System V UNIX).

**Node Version**: Version of your Node.

**Module Version**: Version of MMM-Face-Reco-DNN.

**Description**: Provide a detailed description about the issue and include specific details to help us understand the problem. Adding screenshots will help describing the problem.

**Steps to Reproduce**: List the step by step process to reproduce the issue.

**Expected Results**: Describe what you expected to see.

**Actual Results**: Describe what you actually saw.

**Configuration**: What does the used config.js file look like? Don't forget to remove any sensitive information!

**Additional Notes**: Provide any other relevant notes not previously mentioned. This is optional.

0 comments on commit 6ab42ad

Please sign in to comment.