Skip to content

README contributor quick-start guide #159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
angry-dad wants to merge 2 commits into
base: main
Choose a base branch
from
Open

README contributor quick-start guide #159

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44d1e80
Adding a minimal contributor quick-start for the Jekyll site.
angry-dad Oct 14, 2026
c5f6143
Merge pull request #1 from angry-dad/docs-add-contributing-readme
angry-dad Oct 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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