Skip to content

Commit

Permalink
Merge pull request #997 from datopian/985-tutorial3-collaboration
Browse files Browse the repository at this point in the history
Tutorial 3 (overview): Collaborating with others on your website project
  • Loading branch information
olayway authored Aug 4, 2023
2 parents 30f7de0 + c5ae365 commit 9fc834c
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions site/content/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,55 @@ Below is a screenshot of how the final website will look like:
> [!tip]
> Read full tutorial [[edit-a-website-locally|here!]]
### Tutorial 3: Collaborating with others on your website project

In this tutorial, we will guide you through collaborating with others on the same website project using GitHub.

By the end of this tutorial, you will:

- Understand what a branch is and how to create one.
- Understand what a pull request (PR) is and how to create one.
- Learn how to review and merge a PR.
- Know how to resolve conflicts if they arise.
- Collaborate with others using GitHub, following best practices.

#### Create a new branch

- Navigate to your site's repository on GitHub
- Click on the 'Branch' dropdown menu, type a new branch name and press Enter
- Yay! You've created a new branch! 🎉

#### Now, let's make changes in the new branch

- Switch to the new branch in GitHub Desktop
- Open the `/content` folder of the repository in Obsidian
- Edit the `about` page
- Commit the changes in GitHub Desktop app and push them to the remote repository on GitHub

#### Create a pull request (PR)

- Go back to your site's repository on GitHub
- Click on 'New pull request'
- Select your branch from the dropdown menu
- Write a brief description of your changes, then click on 'Create pull request'
- Yay! Your changes are ready to be reviewed! 🎉

#### Review and merge a pull request

- Navigate to the 'Pull requests' tab in your repository
- Open the newly created pull request
- Review the changes, add comments if necessary
- If everything is in order, click 'Merge pull request', then 'Confirm merge'
- Yay! You've merged your changes into the main branch! 🎉

#### Resolving conflicts

- In case of conflicts between your changes and those on the main branch, GitHub will alert you
- Follow the on-screen instructions to resolve the conflicts and merge your changes

> [!tip]
> Read full tutorial [[collaborate-on-website-project|here!]] (TBD)
## Howtos

- [[quickly-create-a-sandbox-website|How to quickly create a sandbox website]]
Expand Down

1 comment on commit 9fc834c

@vercel
Copy link

@vercel vercel bot commented on 9fc834c Aug 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.