Skip to content
About
Contribution Guidelines

Contribution Guidelines

If you have found a problem on the website, or you would like to suggest an improvement or modification, please submit a GitHub issue.

Updating the website

The WAIS Workshop website is generated with Hugo using the Hextra theme and deployed via GitHub Pages

The content for the website is hosted on GitHub

Steps to Contribute

If you are interested in directly suggesting changes, try to use the following steps:

  1. Fork the repository to your personal GitHub account by clicking the “Fork” button on the project main page. This creates your own server-side copy of the repository.
  2. Clone the repository to your local system and include the --recursive to ensure the submodules are cloned
git clone --recursive https://github.com/waisworkshop/waisworkshop.github.io.git

If you forget to include the --recursive flag, you can fetch the submodules after cloning

git submodule update --init --recursive
  1. Locally, add your fork as the origin remote and set the original project repository as the upstream remote.
git remote set-url origin <your-wais-workshop-repo>
git remote set-url upstream https://github.com/waisworkshop/waisworkshop.github.io.git
  1. Create a new branch to do your work
git checkout -B <new-branch-name>
  1. You can deploy a local copy of the website that includes your local edits by running hugo server
  2. Make your changes on the new branch and commit them
git commit -m <helpful-commit-message>
  1. Push your work to GitHub under your project fork
git push origin <new-branch-name>
  1. Submit a Pull Request from your forked branch to the project repository. From there we will review your pull request before merging your branch into the live website.

General PR Guidelines

  • Make each pull request as small and simple as possible
  • Larger changes should be broken down into their basic components and integrated separately
  • Write your commit messages in clear language that describe the changes made
  • If possible, associate the pull request with a GitHub issue
  • Write your pull request with a clear title and descriptive message
  • Be patient as reviews of pull requests take time

Building with pixi

pixi can also be used to build the website from scratch after cloning the repository:

git clone --recursive https://github.com/waisworkshop/waisworkshop.github.io.git
cd waisworkshop.github.io
pixi run webserver

To see the available pixi tasks:

pixi task list