Welcome to your research repository! This guide will help you work together using Git and GitHub β no prior experience needed. Feel free to modify this, it's only for your introduction to your team's repo.
Clone your repository to your computer:
git clone https://github.com/YOUR-ORG-NAME/YOUR-TEAM-REPO.git
Always work on a separate branch. Never push directly to main.
-
Create a new branch for each task or feature bash
git checkout -b feature-your-name
-
Make your changes locally Work on your files as needed β save your progress often.
-
Stage and commit your changes
git add . git commit -m "Your descriptive commit message"
-
Push your branch to GitHub
git push origin feature-your-name
-
Open a Pull Request (PR)
- Go to the repo on GitHub
- Click "Compare & pull request"
- Add a short description of your changes
- Tag a teammate to review it
Once approved, it can be safely merged into main.
Write clear, useful messages that explain what and why, like:
Add quantum state simulation function
Fix matrix dimensions in tensor product
Update README with cloning instructions
Always sync with the main branch before starting new work:
git checkout main
git pull origin main
Then create your feature branch from the updated main.
- β One branch per feature or fix
- β Pull frequently to avoid merge conflicts
- β Keep your code well-commented and organized
- β Use README.md for explanations
- β Track bugs, tasks, or ideas with GitHub Issues
- β Communicate often in your team chat and meetings, get to know eachother outside of work (lunch, dinner, night on the town)
Ask questions in your team chat, or bring them to your next Advisory or Working Meeting.