Contributing to This Site

Clone repo

git clone https://github.com/UCSCRocketry/rocket-site.git
cd rocket-site/

Create virtual environment

python -m venv venv

Activate virtual environment

On Windows

myenv\Scripts\activate.bat

On Linux and Mac

source venv/bin/activate

Install dependencies

pip install -r requirements.txt

Run local preview

mkdocs serve

Create branch

git checkout -b <my_feature>

Add and commit changes

git add docs/
git commit -m "Did stuff"

Commit with descriptive message

Push

git push

Always preview site before pushing. Do not push directly to main.

Create PR

This happens on Github. Site maintainer must approve PRs.