GitHub user guide:Hello world
The?Hello World?project is a time-honored tradition in computer programming. It is a simple exercise that gets you started when learning something new. Let’s get started with GitHub!
You’ll learn how to:
- Create and use a repository
- Start and manage a new branch
- Make changes to a file and push them to GitHub as commits
- Open and merge a pull request
What is GitHub?
GitHub is a code hosting platform for version control and collaboration. It lets you and others work together on projects from anywhere.
This tutorial teaches you GitHub essentials like?repositories,?branches,?commits, and?Pull Requests. You’ll create your own Hello World repository and learn GitHub’s Pull Request workflow, a popular way to create and review code.
No coding necessary
To complete this tutorial, you need a?GitHub.com account?and Internet access. You don’t need to know how to code, use the command line, or install Git (the version control software GitHub is built on).
Tip:?Open this guide in a separate browser window (or tab) so you can see it while you complete the steps in the tutorial.
Step 1. Create a Repository
A?repository?is usually used to organize a single project. Repositories can contain folders and files, images, videos, spreadsheets, and data sets – anything your project needs. We recommend including a?README, or a file with information about your project. GitHub makes it easy to add one at the same time you create your new repository.?It also offers other common options such as a license file.
Your?hello-world?repository can be a place where you store ideas, resources, or even share and discuss things with others.
To create a new repository
Click?Create repository.?
Step 2. Create a Branch
Branching?is the way to work on different versions of a repository at one time.
By default your repository has one branch named?master?which is considered to be the definitive branch. We use branches to experiment and make edits before committing them to?master.
When you create a branch off the?master?branch, you’re making a copy, or snapshot, of?master?as it was at that point in time. If someone else made changes to the?master?branch while you were working on your branch, you could pull in those updates.
This diagram shows:
- The?master?branch
- A new branch called?feature?(because we’re doing ‘feature work’ on this branch)
- The journey that?feature?takes before it’s merged into?master
Have you ever saved different versions of a file? Something like:
- story.txt
- story-joe-edit.txt
- story-joe-edit-reviewed.txt
Branches accomplish similar goals in GitHub repositories.
Here at GitHub, our developers, writers, and designers use branches for keeping bug fixes and feature work separate from our?master?(production) branch. When a change is ready, they merge their branch into?master.
To create a new branch
Now you have two branches,?master?and?readme-edits. They look exactly the same, but not for long! Next we’ll add our changes to the new branch.
Step 3. Make and commit changes
Bravo! Now, you’re on the code view for your?readme-edits?branch, which is a copy of?master. Let’s make some edits.
On GitHub, saved changes are called?commits. Each commit has an associatedcommit message, which is a description explaining why a particular change was made. Commit messages capture the history of your changes, so other contributors can understand what you’ve done and why.
Make and commit changes
These changes will be made to just the README file on your?readme-editsbranch, so now this branch contains content that’s different from?master.
Step 4. Open a Pull Request
Nice edits! Now that you have changes in a branch off of?master, you can open a?pull request.
Pull Requests are the heart of collaboration on GitHub. When you open a?pull request, you’re proposing your changes and requesting that someone review and pull in your contribution and merge them into their branch. Pull requests showdiffs, or differences, of the content from both branches. The changes, additions, and subtractions are shown in green and red.
As soon as you make a commit, you can open a pull request and start a discussion, even before the code is finished.
By using GitHub’s?@mention system?in your pull request message, you can ask for feedback from specific people or teams, whether they’re down the hall or 10 time zones away.
You can even open pull requests in your own repository and merge them yourself. It’s a great way to learn the GitHub Flow before working on larger projects.
Open a Pull Request for changes to the README
Click on the image for a larger version
| Click the??Pull Requesttab, then from the Pull Request page, click the greenNew pull request?button. | |
| Select the branch you made,readme-edits, to compare with?master?(the original). | |
| Look over your changes in the diffs on the Compare page, make sure they’re what you want to submit. | |
| When you’re satisfied that these are the changes you want to submit, click the big green?Create Pull Requestbutton. | |
| Give your pull request a title and write a brief description of your changes. |
When you’re done with your message, click?Create pull request!
Tip: You can use?emoji?and?drag and drop images and gifs?onto comments and Pull Requests.
Step 5. Merge your Pull Request
In this final step, it’s time to bring your changes together – merging yourreadme-edits?branch into the?master?branch.
Celebrate!
By completing this tutorial, you’ve learned to create a project and make a pull request on GitHub!???
Here’s what you accomplished in this tutorial:
- Created an open source repository
- Started and managed a new branch
- Changed a file and committed those changes to GitHub
- Opened and merged a Pull Request
Take a look at your GitHub profile and you’ll see your new?contribution squares!
If you want to learn more about the power of Pull Requests, we recommend reading the?GitHub Flow Guide. You might also visit?GitHub Explore?and get involved in an Open Source project?
Tip: Check out our other?Guides?and?YouTube Channel?for more GitHub how-tos.
總結
以上是生活随笔為你收集整理的GitHub user guide:Hello world的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 聊聊职场那些事儿(转)
- 下一篇: 代码注释规范-google版本