Skip to content

Commit

Permalink
Merge pull request #173 from AlexsLemonade/sjspielman/contributing-up…
Browse files Browse the repository at this point in the history
…date

Updating contributing
  • Loading branch information
sjspielman authored Mar 13, 2024
2 parents bc438a3 + dd8b565 commit 3f3c7f0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
10 changes: 8 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To serve the documentation during local development, run `mkdocs serve` from the
- [Adding new documentation](#adding-new-documentation)
- [Linking to other pages](#linking-to-other-pages)
- [Adding images](#adding-images)
- [Phrasing](#phrasing)
- [Phrasing and other syntax](#phrasing-and-other-syntax)


## Docs organization
Expand Down Expand Up @@ -102,8 +102,14 @@ To include an image in a docs file, use the following syntax to center the image
</figure>
```

## Phrasing
## Phrasing and other syntax

Only these items should be in backticks:
- Actual code
- References to a specific repository, e.g. `OpenScPCA-analysis`

For consistency, please use the following:

- Refer to `github.com` as "GitHub" (but without quotes) except when providing specific links.
- Refer to git as "Git" (without quotes), not "git"
- If you are actually referring to a git command, you should use `git <command>`
4 changes: 2 additions & 2 deletions docs/technical-setup/clone-the-repo.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Clone the repository

After [forking the `OpenScPCA` repository](./fork-the-repo.md), you will need to _clone_ your forked repository to your computer.
After [forking the OpenScPCA repository](./fork-the-repo.md), you will need to _clone_ your forked repository to your computer.
Cloning provides you with a local copy of the repository to work with.
You will need to clone the repository to every computer (or remote server) you want to use to contribute to the project.

Expand Down Expand Up @@ -32,7 +32,7 @@ For example, your forked repository on GitHub is called `origin` because it is w
We will add another remote repository named `upstream` that refers to the original `AlexsLemonade/OpenScPCA-analysis` repository on GitHub.
This will be called `upstream` because it was the source that your fork came from.

Adding the `AlexsLemonade` _upstream remote_ will allow you to interact with it from your computer which can help you keep your fork in sync with the `OpenScPCA` project.
Adding the `AlexsLemonade` _upstream remote_ will allow you to interact with it from your computer which can help you keep your fork in sync with the OpenScPCA project.
But, you will still be working in your fork when writing analysis code.

Follow these steps to add the upstream remote:
Expand Down

0 comments on commit 3f3c7f0

Please sign in to comment.