From 44d1e80f00fcb5bcf1082ec46951604593e14a06 Mon Sep 17 00:00:00 2001 From: angry_dad Date: Wed, 14 Oct 2026 14:00:11 -0400 Subject: [PATCH] Adding a minimal contributor quick-start for the Jekyll site. The README is currently one line; CI already runs bundle exec jekyll build, so documenting local setup should help newcomers. --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 734cec53..a5ed709d 100644 --- a/README.md +++ b/README.md @@ -1 +1,21 @@ The MustardOS Website, please feel free to open a PR for review as this website is open-source. + +## Contributing + +Small documentation and accuracy fixes are welcome. If you'd like to contribute: + +1. Fork the repository and create a branch for your change. +2. Set up a local preview: + - Install Ruby and Bundler if needed. + - Run `bundle install`. + - Run `bundle exec jekyll serve` to preview the site locally. +3. Open a pull request. + +CI builds the site with `bundle exec jekyll build`, so a local build is a good sanity check before opening a PR. + +### Where to look + +- `release/` — release pages and metadata +- `installation/` — installation guide +- `_data/` — shared site data +- `_includes/` and `_layouts/` — shared templates