diff --git a/Contributing.md b/Contributing.md index e48938d..640e918 100644 --- a/Contributing.md +++ b/Contributing.md @@ -92,7 +92,7 @@ Signing the CLA does not grant you rights to commit to the main repository, but ## Use GitHub, Git, and this repository -**Note:** Most of the information in this section can be found in [GitHub Help] articles. If you're familiar with Git and GitHub, skip to the [Contribute and edit content](#contribute-and-edit-content) section for the specifics of the code/content flow of this repository. +**Note:** Most of the information in this section can be found in [GitHub Help] articles. If you're familiar with Git and GitHub, skip to the [Contribute and edit content](#contribute-and-edit-content) section for the specifics of the code and content flow of this repository. ### To set up your fork of the repository @@ -101,7 +101,7 @@ Signing the CLA does not grant you rights to commit to the main repository, but 1. Create your own fork of this repository. To do this, at the top of the page, choose the **Fork** button. 1. Copy your fork to your computer. To do this, open Git Bash. At the command prompt enter: - git clone https://github.com//office-scripts-docs-reference.git + git clone https://github.com//office-scripts-docs-reference.git Next, create a reference to the root repository by entering these commands: @@ -122,7 +122,7 @@ To make the contribution process as seamless as possible, follow these steps. 1. Submit a pull request to the main repository. 1. Delete the branch. -**Important**: Limit each branch to a single concept/article to streamline the work flow and reduce the chance of merge conflicts. Content appropriate for a new branch includes: +**Important**: Limit each branch to a single concept or article to streamline the workflow and reduce the chance of merge conflicts. Content appropriate for a new branch includes: * A new article. * Spelling and grammar edits. @@ -131,17 +131,17 @@ To make the contribution process as seamless as possible, follow these steps. #### To create a new branch 1. Open Git Bash. -1. At the Git Bash command prompt, type `git pull upstream main:`. This creates a new branch locally that is copied from the latest OfficeDev main branch. +1. At the Git Bash command prompt, type `git pull upstream main:`. This creates a new branch locally that is copied from the latest `OfficeDev/office-scripts-docs-reference` main branch. 1. At the Git Bash command prompt, type `git push origin `. This alerts GitHub to the new branch. You should now see the new branch in your fork of the repository on GitHub. 1. At the Git Bash command prompt, type `git checkout ` to switch to your new branch. #### Add new content or edit existing content -You navigate to the repository on your computer by using File Explorer. The repository files are in `C:\Users\\office-scripts-docs-reference`. +You navigate to the repository on your computer by using File Explorer. The repository files are in `C:\Users\\office-scripts-docs-reference`. To edit files, open them in an editor of your choice and modify them. To create a new file, use the editor of your choice and save the new file in the appropriate location in your local copy of the repository. While working, save your work frequently. -The files in `C:\Users\\office-scripts-docs-reference` are a working copy of the new branch that you created in your local repository. Changing anything in this folder doesn't affect the local repository until you commit a change. To commit a change to the local repository, type the following commands in GitBash. +The files in `C:\Users\\office-scripts-docs-reference` are a working copy of the new branch that you created in your local repository. Changing anything in this folder doesn't affect the local repository until you commit a change. To commit a change to the local repository, type the following commands in Git Bash. git add . git commit -v -a -m "" @@ -168,11 +168,11 @@ When you're finished with your work and are ready to have it merged into the mai One of the site administrators will process your pull request. Your pull request will surface on the [OfficeDev/office-scripts-docs-reference](https://github.com/OfficeDev/office-scripts-docs-reference/pulls) site under **Pull requests**. When the pull request is accepted, the issue will be resolved. -#### Create a new branch after merge +#### Create a new branch after the merge After a branch is successfully merged (that is, your pull request is accepted), don't continue working in that local branch. This can lead to merge conflicts if you submit another pull request. To do another update, create a new local branch from the successfully merged upstream branch, and then delete your initial local branch. -For example, if your local branch X was successfully merged into the OfficeDev/office-scripts-docs-reference main branch and you want to make additional updates to the content that was merged. Create a new local branch, X2, from the OfficeDev/office-scripts-docs-reference main branch. To do this, open GitBash and execute the following commands. +For example, if your local branch X was successfully merged into the OfficeDev/office-scripts-docs-reference main branch and you want to make additional updates to the content that was merged. Create a new local branch, X2, from the OfficeDev/office-scripts-docs-reference main branch. To do this, open Git Bash and execute the following commands. cd office-scripts-docs-reference git pull upstream main:X2 @@ -182,7 +182,7 @@ You now have local copies (in a new local branch) of the work that you submitted git checkout X2 -...and verifying the content. (The `checkout` command updates the files in `C:\Users\\office-scripts-docs-reference` to the current state of the X2 branch.) Once you check out the new branch, you can make updates to the content and commit them as usual. However, to avoid working in the merged branch (X) by mistake, it's best to delete it (see the following **Delete a branch** section). +...and verifying the content. (The `checkout` command updates the files in `C:\Users\\office-scripts-docs-reference` to the current state of the X2 branch.) Once you check out the new branch, you can make updates to the content and commit them as usual. However, to avoid working in the merged branch (X) by mistake, it's best to delete it (see the following **Delete a branch** section). #### Delete a branch @@ -192,7 +192,7 @@ Once your changes are successfully merged into the main repository, delete the b 1. In the Git Bash command prompt, type `git checkout main`. This ensures that you aren't in the branch to be deleted (which isn't allowed). 1. Next, at the command prompt, type `git branch -d `. This deletes the branch on your computer only if it has been successfully merged to the upstream repository. (You can override this behavior with the `–D` flag, but first be sure you want to do this.) -1. Finally, type `git push origin :` at the command prompt (a space before the colon and no space after it). This will delete the branch on your github fork. +1. Finally, type `git push origin :` at the command prompt (a space before the colon and no space after it). This will delete the branch on your GitHub fork. Congratulations, you have successfully contributed to the project! @@ -206,7 +206,7 @@ Fill out the form at [Join GitHub](https://github.com/join) to open a free GitHu You will automatically be sent a notice that you need to sign the Contributor's License Agreement (CLA) if your pull request requires one. -As a community member, **you must sign the Contribution License Agreement (CLA) before you can contribute large submissions to this project**. You only need complete and submit the documentation once. Carefully review the document. You may be required to have your employer sign the document. +As a community member, **you must sign the Contribution License Agreement (CLA) before you can contribute large submissions to this project**. You only need to complete and submit the documentation once. Carefully review the document. You may be required to have your employer sign the document. ### What happens with my contributions?