search

UBCEnvision / UBCEnvision.github.io

:canada: UBC Envision - The AIChE Student Chapter of The University of British Columbia :fire: :mortar_board: :oncoming_automobile: :watermelon:
http://www.ubcenvision.com
4 stars 14 forks source link
aiche british-columbia canada chemical-engineering students ubc university-project

readme

:canada: UBC Envision Build Status

UBC Envision - The AIChE Student Chapter of the University of British Columbia (UBC).

Getting Started

This website is hosted for free on GitHub Pages. We write our content in Markdown and use Jekyll to generate a fast, static and low-maintenance website available at www.ubcenvision.com. Our website design is based on a heavily-modified theme called Story by HTML5Up. Our blog and news articles support MathJax.

Our website data is organized into several folders:

The master branch is protected and commits cannot be made to this branch directly. We use Travis CI to run RSpec tests to ensure all contributions meet our code quality requirements and website standards.

:whale: We now support docker! :whale:

It is now SUPER EASY to contribute to the UBC Envision site with Docker support thanks to @bretfisher!

Step 1: Install Docker

  1. Go to the Docker website
  2. Download for your operating system (Windows, Mac, etc...)

Step 2: Start Docker

  1. Click on the Docker icon :whale:! For Mac it should be in the top menu bar
  2. Select start docker

Step 3: Run a Local Website

  1. Go to your terminal
  2. Navigate to the repository
  3. Run the following command:
docker-compose up
  1. Open a brower and navigate to http://localhost:4000/

Contributing

:+1::tada: Thanks for taking the time to contribute! :tada::+1:

Please take the time to read the contribution guide before you contribute! These are guidelines, not rules. For those with limited coding experience and those who want to learn these will outline some of the best practices to contributing to open source projects. We are aiming to teach best-practices to junior developers so that they are more familiar with work-flow when they reach industry. Members, if you have any questions feel free to message website channel in Slack for a quick response.

Check out Github's Open Source Guide here for more details.

Issues

The FIRST thing you should do when you find something wrong with the website or want to change something is create an issue.

It is best practice to tag your issues! Types of issues include:

Bug

If you find a bug, report it! Submit an issue on Github here and it will be addressed. Ensure to tag it as a bug so that we know to fix it as soon as possible.

Update-Info

Old info can mislead people. It is best to address this ASAP! If you find out-of-date info submit an issue and tag it as update-info.

Enhancement

Have an idea for a cool new software project? Want to make this the best website ever? Submit an issue and tag it as an enhancement. Give us an idea of what you would like to see as a part of this enhancement and see if you can get some help working on it!

Commit Messages

Git Funny

The 7 Rules to a Great Commit Message

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line
  6. Wrap the body at 72 characters
  7. Use the body to explain what and why vs. how

Check out more details here. Thanks to Chris Beams for an awesome how-to article on commit messages.

Pull Requests

Fill out the pull request template and let us know what changes you made! Ensure that the changes are reviewed by another set of eyes before you submit them. For structual changes to the website, make sure that the code is reviewed before it is merged to the master branch.

Check Us Out!

Website

https://www.ubcenvision.com

Contact

contact@ubcenvision.com

:fire: Photos

https://www.instagram.com/ubcenvision :camera:

Theme

Based on Story by HTML5 UP - html5up.net | @ajlkn