Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (42 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

73 lines (42 loc) · 2.5 KB
Raw

CONTRIBUTING

Contributions are always welcome, no matter how large or small. Before contributing, please read the code of conduct.

Prerequisites

Setup

Get a local copy of the website repository

git clone https://github.com/cmubtg/website.git
cd website

Install Dependencies

Only required on the first run. Note: it will take a while for the package manager to install all modules.

npm install

You should now have node_modules appear in the sidebar.

Access Locally

Gatsby Updates

To get a local version running, input the following commands

gatsby clean
gatsby develop

gatsby clean goes through and wipes out the cache. gatsby develop starts the development server.

In the default setting, you should now have a local version of the site running at localhost:8000. The admin site should also be running at localhost:8000/admin.

Netlify CMS Updates

After opening the admin site. Create an account to access the information. The top of the page should look like this.

Screen Shot 2022-01-12 at 3 39 04 PM

To add a new member, simple click on New Members and input the information accordingly.

Pull Requests

All changes should be made in a branch before commiting to master. Please make sure to test your code locally before commiting to ensure that your change does not break the site.

  1. Fork the repo.
  2. Create a branch from master. Branches should be named with the user's andrewID and the issue they are resolving. For example, dsyou_update_homepage_UI.
  3. Run gatsby build to compile the site and make it ready for deployment.
  4. Run gatsby serve to serve the production build of the site.
  5. Once you have confirmed your changes, you can make a pull request and a maintainer will review and accept it accordingly.

License

By contributing to the Gatsby - Netlify CMS starter, you agree that your contributions will be licensed under its MIT license.