Skip to content

Latest commit

 

History

History
117 lines (92 loc) · 3.63 KB

CONTRIBUTING.md

File metadata and controls

117 lines (92 loc) · 3.63 KB

Setup for Code Contributions

Prerequisites

MacOS
  • XCode Command Line Tools xcode-select --install
  • If you already have the full Xcode installed, go to menu Xcode -> Open Developer Tool -> More Developer Tools....
  • Install Node.js >= 16
Windows
  • Install current version of Python3
  • Install Visual Studio Code and add the Microsoft C/C++ extension
  • Install Node.js >= 16
Linux
  • Install Python > 3.7
  • Install make, gcc, and g++
  • Install Node.js >= 16

Repository Setup

  • Fork the project and uncheck the box that says "Copy the main branch only". This step is vital as you will not be able to checkout the beta branch if you do not deselect this option. If you accidentally left it checked. Delete the fork you just made and start over.
  • Open a Terminal and navigate to where you want the project repository to exist
  • Clone your forked repository 
    git clone https://github.com/<your-github-user>/club_website.git
  • Navigate into the root directory 
    cd club_website
  • Set the upstream remote 
    git remote add upstream https://github.com/nsccs/club_website.git
  • Switch to beta branch 
    git checkout beta
  • Install required packages 
    npm install
  • Start server 
    npm run dev

Optional Local Database Setup

Only do these steps if you are actively working on database changes.

  • Install mariadb community edition for your platform
  • Run the server
  • Run club_website.sql script to add the database and tables. The recommended way is to import the data with mySQL WorkBench.
  • Create a .env.local file and add:
DB_HOST=localhost
DB_PORT=3306
DB_USER=<database user>
DB_PASSWORD=<database password>
DB_NAME=club_website

If any changes are made to the database please remember to update the setup.sql file to reflect these changes. Recommended method is with mySQL WorkBench

  • Select Server menu item
  • Select Data Export
  • Select the box for club_website and to the right select Dump Structure Only
  • Under Export Options select Export to Self Contained file and make sure the path and filename are <path_to_file>/club_website.sql
  • Click Start Export button
  • Include file in Pull Request

Find Something to Work On

Navigate to the Issues tab and use the filters to see open issues. Take note of the good first issue and help wanted labels. If you decide to start working on an issue, make sure write a comment to let others know!

Also, remember to pull the most recent work from the upstream beta branch before starting your work!

git pull upstream beta

Submit a Pull Request

  • Create your feature branch. Please use all lowercase letters with dashes instead of spaces.

    git checkout -b <specific-feature>

  • Test your feature. Manually test that your feature has not broken anything else in on the site and works as expected.

    npm run dev

  • Add your work

    git add .

  • Commit your changes

    git commit -m 'Add a clear and specific message about what the commit contains.'

  • Push to the branch

    git push origin <specific-feature>

  • Go to the project Github page to open a pull request. You will select the nsccs:beta branch from <your-repository>:<your-forked-branch>. Include all the relevant information requested in the template.

  • Request a review from christopher0331, uellenberg, or jaredscarr.

Don't forget to give the project a star! Thanks again!