Skip to content

Cima9642/Developer-Training

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 

Repository files navigation

First Pull Request - Learn by Doing! 🎯

Welcome! This repository is designed to help you make your very first pull request (PR) in an safe, beginner-friendly environment.

What You’ll Learn

  • How to fork a repository
  • How to clone your fork locally
  • How to crea a branch
  • How to make changes and commit them
  • How to push changes to GitHub
  • How to create a pull request

Your Mission 🎯

This README contains intentional typos. Your task is to:

  1. Find and fix the typos
  2. Submit your fixes via a pull request
  3. (Optional) Add yourself to the CONTRIBUTORS.md file

Don’t worry - you can’t break anything! This is a practice repo designed for learning.

Prerequisites

Step-by-Step Guide

1. Fork This Repository

Click the “Fork” button at the top right of this page. This creates your own copy of the repository.

2. Clone Your Fork

git clone https://github.com/YOUR-USERNAME/first-pull-request.git
cd first-pull-request

Replace YOUR-USERNAME with your aual GitHub username.

3. Create a New Branch

git checkout -b fix-typos

You can name your branch anything descriptive like fix-readme-typos or your-name-typo-fixes.

4. Make Your Changes

Open README.md in your favorite text editor and fix the typos you find. Look carefully - there are typos throughout this document!

5. Commit Your Changes

git add README.md
git commit -m "Fix typos in README.md"

6. Push to GitHub

git push origin fix-typos

7. Create a Pull Request

  1. Go to your fork on GitHub
  2. Click “Compare & pull request”
  3. Add a clear title like “Fix typos in README.md”
  4. Describe what you fixed
  5. Click “Create pull request”

Congratulations! You’ve just made your first pull request! 🎉

Need Help?

(Optional) Add Yourself as a Contributor

After fixing typos, you’re welcome to add your information to CONTRIBUTORS.md:

### Your Name
- GitHub: [@yourusername](https://github.com/yourusername)
- LinkedIn: [Your LinkedIn](https://linkedin.com/in/yourprofile) (optional)
- About: A sentence or two about yourself!

About Pull Requests

GitHub Pull Requests (PR) are a vital tool for collaborating on code and contributing to open source projects.

In this article, we’ll cover some best practices for using pull requests effectively to streamline your workflow and ensure that changes are reviewed and tested before being merged into the main codebase.

Best Practices:

  • Create descriptive pull request titles and descriptions: When you create a pull request, be sure to give it a descriptive title that summarizes the changes you’ve made. It’s also a good idea to include a detailed description of the changes in the pull request body, including any relevant context or background information. This will help other team members understand the changes you’ve made and why they’re necessary.
  • Use branches to isolate changes: When making changes to a codebase, it’s a good idea to create a new branch for each set of changes you want to submit. This will make it easier to review and test the changes, and it will also allow you to make additional changes to the codebase without affecting the main branch.
  • Keep pull requests small and focused: It’s generally easier to review and test smaller pull requests than larger ones. Try to limit your pull requests to a single, focused change rather than a large number of unrelated changes. This will make it easier for other team members to review and test your changes.
  • Use code review tools: GitHub provides a number of tools to help you review code, including inline comments, line-by-line review, and code review templates. Use these tools to provide feedback and suggestions for improvement on the code you’re reviewing.
  • Respond to feedback and requests for changes: If someone leaves ga comment or requests changes on your pull request, be sure to respond in a timely manner. This will help ensure that the review process stays on track and that any necessary changes are made before the pull request is merged.
  • Test your changes: Before submitting a pull request, be sure to test your changes to ensure that they work as expected. This will help ensure that the changes are ready to be merged and that they don’t introduce any new bugs or issues.

By following these best practices, you can streamline your workflow and ensure that your pull requests are reviewed and tested effectively. With a little bit of practice, you’ll be able to use GitHub Pull Requests to collaborate on code and contribute to open source projects with confidence.

Code of Conduct

This project adheres to the Contributor Covenant. By participating, you are expected to uphold tho code. Please report unacceptable behavior to Cima9642.


Happy Coding! 🚀

Remember: Everyone started as a beginner. This is your safe space to learn and make mistakes!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •