Welcome to the Software Systems Student Society (SSSS) website repo. This project is maintained by the website committee.

To join the committee, go to the SSSS Discord server, find the #what-are-committees, and claim the @website role.

View the live site here: https://sfussss.org/

1. Navigate to the issues page in this repository
2. Add a new Issue and give it a clear and concise title and description. Include any other information, images, etc. that may be needed.
3. Give it an appropriate label
4. Thank you for your contribution! The committee may assign the issue as appropriate.

1. Get access to the repository as a contributor by contacting the website committee on our our Discord server

2. Claim a free task from the open issues or suggest a new issue

3. Set up your development environment (terminal instructions):

   Quick context:

   • Bun is the package manager/runtime used in this repo. You can think of it like npm, but faster.
   • Husky runs automatic checks when you commit (for example formatting checks) so bad commits are caught early.

   Prerequisites:

   • Install Node.js 20+ (recommended LTS)
   • Install Bun from bun.sh

   a. Clone the repository locally in a folder of your choice

   git clone https://github.com/ssss-sfu/ssss-sfu.github.io.git
   

   b. Change directories into the newly cloned project folder

   cd ssss-sfu.github.io
   

   c. Install dependencies

   bun install
   

   Husky hooks are set up automatically after install. If they do not run on commit, run:

   bunx husky
   

   d. Create a new branch from Github Issue UI

   

   [issue-number]-[issue-name]
   

   e.g. 121-poc-implement-course-explorer

   git checkout -b 121-poc-implement-course-explorer
   

   This will create a new branch and check out instantly to that branch. Equivalent with:

   git branch kiaanc/read-me-update
   git checkout kiaanc/read-me-update
   

   e. Run the server locally

   bun run dev
   

   f. View the project in your browser

   localhost:3000
   

4. Start coding!

5. Commit and push your changes

6. Create a pull request with the following format:

   Target Branch: master
   
   Title: Clear and descriptive title relevant to the issue
   
   Description: Any relevant information about the changes made
   
   Reviewers:
   - Highfire1 (Anderson)
   

7. Wait for one of the reviewers to take a look and make changes or merge accordingly.

Thanks for contributing!