Skip to content

Latest commit

 

History

History
31 lines (26 loc) · 2.54 KB

CONTRIBUTION.md

File metadata and controls

31 lines (26 loc) · 2.54 KB

Contributions

This project welcomes contributions and suggestions. Contributions in most cases grant us and anyone else the rights to to use your contribution under the MIT License as defined within this site.

Valid Contributions

Often it isn't clear what a valid contribution is. To help solve this each area you can publish to will contain a contribution file with any specifics you will need to do to make the contribution valid. At a minumum for any solution you provide the following items should be included:

  • Installation documentation if needed
  • Solution overview describing the use case, what the solution does
  • Any special instructions for deploying and running your solution
  • The pythonn or JavaScript files needed along with any technical details about running the scripts

General Steps for all Solutions

Use this methods for a brand new or update to an existing contribution:

Pull Request

After you push your changes, you will need to submit the Pull Request (PR)

  • Note: Details about the Proposed Changes are required, be sure to include a minimal level of detail so a review can clearly understand the reason for the change and what he change is related to he code or update.

After submission, you will need to check the Pull Request for comments

  • Make any changes as suggested and update your branch or explain why no change is needed. Resolve the comment when you are done.