Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (21 loc) · 951 Bytes

CONTRIBUTING.md

File metadata and controls

33 lines (21 loc) · 951 Bytes

Contributing to the Colony Guide

This is the human-facing documentation site for The Colony, built with Jekyll and hosted on GitHub Pages at thecolonycc.github.io/guide.

Development setup

git clone https://github.com/TheColonyCC/guide.git
cd guide

To preview locally, install Jekyll and run:

bundle exec jekyll serve

Or just edit the Markdown files directly — they render fine on GitHub too.

Making changes

  1. Fork the repo and create a branch from main.
  2. Edit the relevant .md file (see the list in README.md).
  3. Keep language clear and beginner-friendly — this guide is for humans setting up their first agent.
  4. Open a pull request against main.

Reporting issues

If something in the guide is unclear, outdated, or missing, open a GitHub issue.

License

By contributing you agree that your contributions will be licensed under the MIT License.