Skip to content

Cima9642/Developer-Training

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 

Repository files navigation

First Pull Request

Hello stranger!

This Repo is gonna help you and guide you through your first PR (Pull Request).

I have also been trying to find a repo where I can contribute and share my code with others, this repo is meant to help you first hand on what to do and how.

This also assume that you already know how to create a pull request if you don't no worries this guide can show you how.

Additionally feel free to add your name, github profile and a little bit about yourself inside the "contributors" file inside this repo. If you'd like to add your LinkedIn that's allowed as well.

Welcome to my project! This is a sample README file that demonstrates how to format a README file properly.

Installation

To install this project, simply clone the repository and run npm install.

Usage

To use this project, run npm start and follow the on-screen prompts.

Contributing

If you'd like to contribute to this project, please follow these guidelines

  • Fork the repository
  • Create a new branch for your feature
  • Commit your changes and push to the new branch * Open a pull request and describe your changes Please note that all contributions must follow our code of conduct.

Code of Conduct

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

Clues

Here are some typos that I included in this sample README file:

"To isntall this project, simply cloan the repository and run npm intall."

"To use this projet, run npm strt and follow the on-screen promts." "If you'd like to contribte to this project, please follow these guideliness:" "Pleae note that all contribtions must follow our code of condut." "This projet adheres to the Contributor Covnent." "Pleae report unacceptble behaviour to [email protected]." "This projet was created by Your Nmae." "This project is licenesed under the MIT Licence."


GitHub Pull Requests (PR) are a vytal tool for collabarating on code and contrybuting to open source projects.

In this artical, we'll cover some best practices for using pull requests effectivly to streamline your workflow and ensure that chanes are reviwed and tested before being merged into the main codebase.

  • Create descriptive pull request titles and discriptions: When you create a pull request, be shore to give it a discriptive title that summarizes the chanes you've made. It's also a good idea to incloode a detaled description of the chanes in the pull request body, including any relevent context or background information. This will help other team members understand the chanes you've made and why they're necessary.

  • Use branches to isolate chanes: When making chanes to a codebase, it's a good idea to create a new branch for each set of chanes you want to submit. This will make it easier to review and test the chanes, and it will also allow you to make addishunal chanes to the codebase without affecting the main branch.

  • Keep pull requests small and focussed: It's generally easier to review and test smaller pull requests than larger ones. Try to limit your pull requests to a single, focussed chane rather than a large number of unrelated chanes. This will make it easier for other team members to review and test your chanes.

  • 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 chanes: If someone leaves a comment or requests chanes on your pull request, be shore to respond in a timely manner. This will help ensure that the review process stays on track and that any necessary chanes are made before the pull request is merged.

  • Test your chanes: Before submitting a pull request, be shore to test your chanes to ensure that they work as expected. This will help ensure that the chanes are ready to be merged and that they don't intruduce 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 effectivly. With a little bit of practice, you'll be able to use GitHub Pull Requests to collabarate on code and contrybute to open source projects with confidance.

Happy Coding!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •