Skip to content
This repository has been archived by the owner on Aug 12, 2024. It is now read-only.

Latest commit

 

History

History
22 lines (15 loc) · 1.04 KB

CONTRIBUTING.md

File metadata and controls

22 lines (15 loc) · 1.04 KB

Contribution Guidelines for sdf

Project scope

The purpose of this project is to provide an easy way to interact with 3D and 2D models using the flexible aspect of signed distance functions.

Code should favor readability and explicitness over cleverness. This makes code easy to review and verify, not only at submission, but also for users who want to understand how the algorithms work. Where possible, the source of algorithms should be referenced in the comments.

What can I do to help?

If you are looking to help out with sdf, there are several places you can start.

You can use sdf and create an issue about where it falls short. You can add functions which are missing in the form2 and form3 packages but present in sdfx. You can add examples. You can add or improve tests. You suggest and/or implement new features you think belong in sdf.

Style

We use Go style.

Relevant source: [1] Gonum's CONTRIBUTING.md.