diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..11ef12c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,34 @@ +Contribution Policy forMMM-MotionControl +==================================== + +Thanks for contributing to MMM-MotionControl. + +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-MotionControl. + +**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.