Skip to content
SuisCode

THE SUISCODE STARTER TOOLKIT

Every developer
starts somewhere.

Small steps from your first project to your first contribution. Follow your club organizer’s guidance and the instructions in each repository.

RESOURCE / 01

SuisCode Quick Start

You do not need programming experience to begin. Choose a club that interests you, then ask your club organizer for the current starter project and joining instructions.

  1. Discover the three clubs and choose a learning path.
  2. Create your account, or sign in if you already have one. Use a display name and profile that follow school guidance; avoid sharing personal information.
  3. Ask your organizer which tutorial or repository your group is using. Some course repositories may require an invitation.
  4. Read the project README. Follow its installation and run instructions, then make one small change.
  5. Run it, save your work, and share your progress with your club.

If registration is unavailable, ask your club organizer for access. Check that a repository is intended to be public before publishing student work.

RESOURCE / 02

Git Basics

A repository stores your project and its history. A commit records one meaningful change. A branch lets you work on an idea before it is reviewed and merged.

  1. Install Git from the official Git website.
  2. Open a project you have permission to contribute to. Copy the HTTPS or SSH clone URL from its repository page.
  3. Clone the repository and enter the new folder. Replace the example URL and folder below with your actual project.
git clone https://git.suiscode.com/OWNER/REPOSITORY.git
cd REPOSITORY
git switch -c my-first-change

Before your first commit, configure the identity that will appear in Git history. Use an approved display name and the private commit email shown in your account settings when privacy is needed. Never commit passwords, access tokens or personal information.

git config user.name "YOUR APPROVED DISPLAY NAME"
git config user.email "YOUR PRIVATE COMMIT EMAIL"

Edit one file, run the project, then inspect and commit your change. Replace the example file name below.

git status
git diff
git add path/to/changed-file
git commit -m "Describe the change"
git push -u origin my-first-change

HTTPS pushes may require an access token when account security settings require it. SSH uses a key added under your account’s SSH key settings; copy the SSH URL from the repository page, including its configured port. Keep private keys and tokens secret. If you cannot push to a shared repository, ask for contributor access or fork it if your organizer permits.

RESOURCE / 03

Working with Issues

Issues are a shared place to plan work, report a bug, and discuss an idea.

  1. Read the project README and existing Issues before opening a new one.
  2. For a bug, describe what you expected, what happened, and how to reproduce it. Include relevant version information.
  3. For a feature, describe the problem and propose a small, achievable improvement.
  4. Agree on who will work on the task before starting. Ask for help when the next step is unclear.

Remove personal information and secrets from screenshots, logs and sample data. Some projects may disable Issues; follow that project’s contribution instructions.

RESOURCE / 04

Your First Pull Request

  1. Check the contribution rules and discuss your task in an Issue.
  2. Create a branch, make one focused change, and run the relevant project checks.
  3. Commit and push your branch. On the repository page, open a Pull Request from your branch into the project’s default branch.
  4. Describe the problem, your change, and how you tested it. Link the Issue and include a screenshot if it helps.
  5. Request review from your organizer or teammate. Respond constructively and push improvements to the same branch.
  6. Let an authorized maintainer merge when the contribution is ready. Update documentation and share what you learned.

A Pull Request is a conversation about improving the project. You do not need a perfect first attempt. Do not force-push shared branches or merge another person’s work without agreement.

RESOURCE / 05

Repository README Guide

A good README helps another student understand, run and contribute to your project. Create a README.md in the repository root with these sections:

Add screenshots or demos only when you have permission to publish them. Never include student contact details, passwords or tokens.

RESOURCE / 06

Collaboration Rules

These are starter community guidelines, not a statement of formal school endorsement. Club organizers may provide additional requirements for their activities. Ask an organizer when access, publishing permission or the expected workflow is unclear.

RESOURCE / 07

Intro to Cybersecurity

Explore digital security, security fundamentals and responsible practice. Detailed modules, projects, schedules and membership requirements will be shared by club organizers when the syllabus is finalized.

Begin with protecting your own accounts, recognizing sensitive information, and understanding why permission matters. Do not probe, scan or test other people’s systems without explicit authorization. Back to our clubs →

← Back to SuisCode