Skip to content

Commit

Permalink
Merge branch 'main' into sjspielman/122-conda-setup
Browse files Browse the repository at this point in the history
  • Loading branch information
sjspielman committed Mar 13, 2024
2 parents 209bef7 + 6715000 commit 2b86628
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 8 deletions.
5 changes: 3 additions & 2 deletions .github/DISCUSSION_TEMPLATE/modify-an-existing-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ body:
description: |
Please add any other relevant details.
Examples of information that would be helpful:
- Are the resource requirements different from what is already in place?
- Provide a general timeline, if possible.
- Are the resource requirements different from what is already in place?
- Provide a general timeline, if possible.
validations:
required: false
5 changes: 3 additions & 2 deletions .github/DISCUSSION_TEMPLATE/propose-a-new-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ body:
description: |
Please add any other relevant details.
Examples of information that would be helpful:
- What computational resources do you anticipate using?
- Provide a general timeline, if possible.
- What computational resources do you anticipate using?
- Provide a general timeline, if possible.
validations:
required: false
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 @@ -103,8 +103,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 2b86628

Please sign in to comment.