Welcome to the GU-Technical-Training-2026 repository! This guide will walk you through setting up the project on your local machine, making changes, and contributing to the repository. It is designed with beginners in mind, providing detailed instructions for every step.
- Prerequisites
- Cloning the Repository
- Setting Up the Project
- Making Changes
- Pushing Changes
- When to Push Changes
- Creating a Pull Request
- Additional Tips
Before getting started, ensure you have the following installed:
- Git: Download and install Git.
- Text Editor/IDE: Use any text editor like VS Code, IntelliJ, or Sublime Text.
- GitHub Account: Sign up at GitHub if you don't already have an account.
- Basic Terminal Knowledge: Familiarity with basic terminal commands will be helpful.
To start working on the repository:
- Open your terminal (or command prompt).
- Navigate to the directory where you want to clone the repository.
cd /path/to/your/folder
- Clone the repository using the following command:
git clone https://github.com/your-username/GU-Technical-Training-2026.git
- Navigate into the cloned repository:
cd GU-Technical-Training-2026
- Check the contents of the repository:
ls # On Linux/Mac dir # On Windows
- Open the project in your preferred text editor/IDE.
It is important to make changes in a separate branch to avoid conflicts:
git checkout -b feature/your-feature-name
Edit the files you want in your text editor or IDE. Save your changes when done.
Use the following command to see the modified files:
git status
Stage the files you want to commit:
git add filename.ext
# Or stage all changes
git add .
Write a meaningful commit message describing what you have done:
git commit -m "Added feature X to do Y"
Push the branch to the remote repository:
git push origin feature/your-feature-name
- Go to the repository on GitHub.
- Click the "Pull Requests" tab.
- Click the "New Pull Request" button.
- Select your branch and describe your changes.
- Submit the pull request.
Push your changes when:
- You have completed a small, self-contained task.
- You want to back up your work.
- You need to share your progress with teammates.
Avoid pushing half-done work unless it is necessary to collaborate.
- Ensure your branch is up-to-date with the main branch:
git checkout main git pull origin main git checkout feature/your-feature-name git merge main
- Resolve any merge conflicts if they arise.
- Push the updated branch and create the pull request as described earlier.
- Sync Regularly: Pull the latest changes from the main branch before starting new work:
git pull origin main
- Use Clear Commit Messages: Write concise and descriptive commit messages.
- Avoid Committing Large Files: Ensure you do not commit unnecessary large files or sensitive information.
If you face any issues, feel free to reach out to the repository maintainers for help.
Thank you for contributing to GU-Technical-Training-2026! Together, we can build something amazing.