diff --git a/docs/further_reading/version_control.mdx b/docs/further_reading/version_control.mdx index 82be5659..b23c1c35 100644 --- a/docs/further_reading/version_control.mdx +++ b/docs/further_reading/version_control.mdx @@ -16,30 +16,18 @@ Git is a version control system that enables you to track changes to files. With Nearly all operations that are performed by Git are in your local computing environment, with the exception of a few used to synchronize with the GitHub remote host. Some of the most common git operations are depicted below. -Git basics +Git basics If you would like to make any changes to current repository, it is always good to start with creating a feature branch, where you can save all the changes. -Example branches diagram +Example branches diagram ## Create a Pull Request Pull requests are useful before you merge your branch with the main branch. You can request a review from your colleagues and check for any conflicts with the main branch. After you pushed all the changes to your branch, you can go to the original GitHub repository and click on the pull request. -Create a pull request -Add reviewers to a pull request +Create a pull request +Add reviewers to a pull request ## Best Practices @@ -113,7 +101,7 @@ Honeycomb is an active project, and will be updated with new features over time. 3. Merge the current Honeycomb repo ```shell - git merge honeycomb/main --allow-unrelated histories + git merge honeycomb/main --allow-unrelated-histories ``` :::caution