Skip to content

Latest commit

 

History

History
68 lines (43 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

68 lines (43 loc) · 2.52 KB
Raw

Contributing

Thanks for your interest in helping us maintain our course notes! We are happy to consider contributions from faculty and students to help make these notes easier to use and improve their correctness.

Requirements

These notes are built using Docusaurus, a modern static website generator. To use it, you'll need to have the following installed:

  • an LTS version of node.js, which can be checked by running node -v. Currently that's node.js 14.x, but confirm with the official site.

  • The yarn package manager, version >= 1.5 (which can be checked by running yarn --version).

  • Visual Studio Code. This is not strictly necessary, but we encourage it since we use various extensions to make working on the site easier.

Installation

To install the dependencies, use:

yarn install

Local Development

To develop the site, use:

yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Workflows

If you want to make a change, please use the following GitHub workflow:

  1. fork this repo on GitHub
  2. clone your forked repo to your local machine, git clone https://github.com/{your username}/IPC144
  3. create a new branch off of the main branch, git checkout -b {new branch name} main
  4. make your changes and save
  5. check to see which files have changed, git status
  6. stage these changed files in git, git add file1 file2 ...
  7. commit your changes, git commit -m "Made the following changes..."
  8. push your commits and branch to your fork, git push origin {new branch name}
  9. create a Pull Request on GitHub
  10. add a description about what you changed and anything the maintainers need to know

Releases

Build

To create a production build, use:

yarn build

This command generates static content in the build/ directory and can be served using any static contents hosting service, for example: GitHub Pages.

Deployment

To build and deploy to GitHub Pages, use:

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.