Contributing to Structs.sh

Before you begin

Feel free to use your preferred LLM to help along the way — the guidelines below are intentionally concise!

Getting started

• Clone the repository and install the development dependencies:

git clone git@github.com:devsoc-unsw/structs.sh.git structs
cd structs
npm install

• Start the project locally:

docker compose up --build

Contribution models

There are two ways to contribute to Structs.sh:

Subcommittee members

• Follow GitHub's shared repository model.
• Use Conventional Branch when naming branches.
• Discuss ideas, questions, or ongoing work in the internal Discord server.

External contributors

• Follow GitHub's fork and pull model.
• If you need a hand, open a help wanted issue or contact us.