Contribute

Background

The devFrame is licensed under the CERN OHL. It is Open Source Hardware and is intended to be hacked/modified/improved. However, it is currently difficult to collaborate on an open source hardware project due to a lack of free tools and open file formats for parametric modeling. The situation is getting better, but, for now, the easiest thing to do is to use a GitHub workflow to clone the project and submit a pull request. Just keep in mind that GitHub is not optmized for hardware project collaboration. But we can make it work.

Making The Docs Better

If you have found typos, or spelling errors, or find something confusing in the docs please let us know by filing an issue. Creating the docs for this project took longer than designing the frame. They are a key part to making this project a success, so please do let us know if you find any issues. All devFrame docs live in the /docs folder and we are happy to accept pull requests for fixing spelling, broken links, etc.

Designing New Parts

The devFrame has standardized interfaces. Like an API we will try very hard not to change the interface specs so you can design new mounts and accessories to these standards. We have provided all parts in both stl and step format. Step format is intented for those who would like to import into 3D CAD software for modification. Please export any new parts in both stl and step formats for any pull requests.

Hosting Community Builds

If you have built and tested a devFrame we would really like to host the details. It’s one of our primary goals. Most of the data in our build section is pulled from Google Sheets. So if you can type a bit of information in a spreadsheet we can bring it into the site here for others to benefit. Expect more details on this process as we refine the site and the workflow to contribute. For now, a link to a short YouTube video and a copy of your parameter files is a great start.

Pull Requests

New to git? Have a look at GitHub Flow

To submit a pull request:

  1. Clone the repo
  2. Create a branch off of master and give it a meaningful name such as my-new-sensor-mount
  3. Commit your changes to your new branch
  4. Push your changes to your new branch
  5. Open a pull request on GitHub