Home

Welcome to the OSIMP Pairing Client wiki!

New to open source? Nervous about Git? Read our tutorial below! Feel free to message Shiina on discord to request tutorials.

If you want an alternative to using Git in the terminal, try GitHub Desktop (doesn't need Git installed beforehand): https://desktop.github.com/

1. Assign yourself to the issue to the issue on GitHub.

You can do this on the top right under 'Assignees'. If you're working with multiple people, make sure to add everyone in your group.

2. If you have any questions on the issue, ask the person who opened it or consult the officer team

3. Fork the repository.

Under the repo, there is a 'Fork' button that will allow you to make a copy of our repo on your personal account.
This allows you to do whatever you want to the repo with no consequences.

4. To start working, we recommend that you create branches instead of working on main.

This allows for neater workflow and helps avoid merge conflicts on main when working with multiple people.

git checkout -b "your-branch-name"

This command will create or otherwise switch over to the specified branch
You can name your branch whatever you want but I recommend you keep it relevant to the issue you're working on so you don't get confused.

5. Add your commits and changes to your branch

6. If you are working with multiple people, make sure to merge main into your feature branch as you work.

Even if you are not working with other people, this can be a good habit to make sure you are keeping your branch up to date with main.
You can resolve merge conflicts in your own branch by keeping your feature branch changes over main, then merge your branch to main so that the merge process is smooth.

7. After you are done working, create a pull request on GitHub to merge your branch into the main branch.

Make sure to follow the template and fill out all necessary sections!
The main branch should only contain code that is working and what we want to deploy.
Never push unfinished or buggy code to main. Main is your one constantly working and up to date branch. Don't push anything to main unless you're done working!!

8. At least one other person should look over your code and approve your pull request before you merge it into main if you are working in a group

This means that submitting a pull request doesn't mean that your work is done; you may need to make some changes based on comments we make.
If you get comments, use this as an opportunity to grow and improve, not as a setback. ;)

9. Check that your code is working on the main branch, then delete your branch if done using

If you think you're gonna come back to this branch then feel free to keep it. Cleaner git logs, code, and repos, will be easier to follow.