Skip to content

Latest commit

 

History

History
19 lines (15 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

19 lines (15 loc) · 1.4 KB

License aggreement

  • If you share issues and ideas, you give permission to project owner or other contributors to implement them under the license of the project.
  • Contributors give permission to project owner to include their work in the repository under the project license (CC BY-NC-SA 4.0 Deed).
  • Project license (CC BY-NC-SA 4.0 Deed) requires that any remix of the original work must be shared under same or similar license. Therefore, if contributor requests inclusion of the remixed work in this repository and if any attribution to contributor is required as a consequence, contributors agree that listing their GitHub profile in the Contributors section is sufficient.

Contributor guidelines

Before submitting pull requests, ensure that your contribution is going to adhere to these rules:

  • Keep changes to existing top level parameters to minimum
  • If you add feature that introduces new top-level parameters or significantly alters the shape of the model, always:
    • Update all technical drawings and images if necessary
    • Set all parameters for the customizer, including comments
    • Update presets with the new parameters. Set their values so that the final model is as close to original preset as possible.
    • Update README.md if necessary
  • Try not to use hull() or minkowski(), to maintain compatibility with FreeCAD
  • Keep things as simple as possible
  • Only use your own code