Contributing

You may be wondering how to contribute and make changes to the PS Wi-Fi website. This page will cover everything you need to know!

You will need:
Go through for Visual Studio Code and Ruby that match the Operating System you are currently using (i.e if you're on Windows, go through the Windows setup instructions).

1. Cloning PSWiFi.github.io

After following the setup instructions, you will need to clone the repository in Visual Studio Code by doing the following:

  • Fork the repository using GitHub — Forking the repository creates your own copy of the site to which you can make changes.
  • Open a new window in Visual Studio Code — If you already have something open, click file > New Window.
  • Click Clone git Repository — Select a known location on your PC for the repositiory to be copied into.
If done correctly, you should end up with something like this.

2a. Command Line Instructions (First Time)

For first time setup, you will need to do the following:

  • Open the folder that contains the repository in File Explorer.
  • Type cmd inside the path bar.
    • A Terminal/Command Prompt window should now be visible.
  • Type bundle install and press Enter to install all the relevant dependencies.

2b. Command Line Instructions (Running the Site)

The following steps assume you have a terminal/command prompt window opened in the folder containing the site. Please follow the instructions under Section 2a to do this if you are not sure how.

  • Type bundle exec jekyll serve --livereload inside the terminal window, then wait for the website to finish generating.
  • Once the website has generated, you will be able to view it using your browser by visiting http://localhost:4000.
You can now make any changes you like using Visual Studio Code. After saving the changes they will be live on your locally hosted version of the website, refresh the page you are editing on http://localhost:4000 to make sure everything is correct.

3. Submitting a Pull Request
  • Save and commit your changes onto your GitHub fork with a descriptive commit name.
  • Follow these instructions to submit your pull request.
  • Ping @Website in the #website discord channel to say you have a PR that is pending approval.

I'm done reading this page! Send me home!