Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

39 lines (30 loc) · 1.7 KB
Raw

Contributing

Laptop is broken into components to maximize sharing between operating systems and linux distros, while retaining the easy hackability of a "single file" installation.

To extend / modify laptop:

  1. Find a component that most closely fits what you want to change. If nothing seems appropriate, create a new one. The best way to learn about how the components are split is to read the manifests and look at the contents of the files they reference. It is ultimately pretty simple.

  2. Make your changes within the component, prioritizing "common-components" that can be shared easily amongst manifests. OS / distro-specific components are fine, but be sure they are necessary first.

  3. Render the installation files from the manifests via the ./bin/build.sh script, run from the repo root. You should see your changes reflected in the rendered linux, linux-preqrequisites, or mac files. git diff is your friend - check the output. If it looks as expected, commit the rendered installation files.

  4. A reminder: be extra sure to render the installation files before issuing a pull request.

  5. (Extra credit, linux only): run the vagrant-supplied automated test suite to test your changes on the supported linux distributions, as described in TESTING.md. You will need > 15gb of disk space, lots of bandwidth, and oodles of CPU and RAM.

Supporting additional distros or operating systems

See above. Ideally, you can mix-and-match existing components to do most of the work, replacing only the debian-package-update and debian-derivative-packages components with your distro-specific files. It will probably be more work than that, but not much.