Skip to content

Commit 7f7bcf8

Browse files
NeoKishhaileyajohnson
authored andcommitted
Fixed some typos
1 parent 17cb79c commit 7f7bcf8

File tree

4 files changed

+14
-14
lines changed

4 files changed

+14
-14
lines changed

docs/dev_guide/contribute.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Thank you for considering making a contribution to CDIPpy! We welcome all types
99
## Setting up your git workflow
1010
This project uses a fork-and-pull-request workflow. You will need to make your [fork](https://github.com/cdipsw/CDIPpy/fork) of the repository to work in, and submit changes to CDIPpy via pull request. To set up your workflow, follow these instructions:
1111

12-
1. Fork the respository at [https://github.com/cdipsw/CDIPpy/fork](https://github.com/cdipsw/CDIPpy/fork)
13-
2. Clone the repository from your fork `git clone https://github.com/{your_github_username}/CDIPpy.git` - this will add your own fork as your `origin` remote repo. *Note: If you already have the main fork cloned, skip to the next step and follow instuctions to add your fork as another remote.*
12+
1. Fork the repository at [https://github.com/cdipsw/CDIPpy/fork](https://github.com/cdipsw/CDIPpy/fork)
13+
2. Clone the repository from your fork `git clone https://github.com/{your_github_username}/CDIPpy.git` - this will add your own fork as your `origin` remote repo. *Note: If you already have the main fork cloned, skip to the next step and follow instructions to add your fork as another remote.*
1414
3. Add the main fork as another remote (or your fork, if you cloned from the main fork). This will allow you to pull latest code from the main fork, but push your own development to your own fork:
1515
```bash
1616
git add remote cdip https://github.com/cdipsw/CDIPpy.git
@@ -26,21 +26,21 @@ git checkout main # make sure this is cdip/main not your fork
2626
git pull
2727
git checkout -b example-branch
2828
```
29-
This will create a new branch called `example-branch` based on the lastest commit to `main`. Now you can start making your changes.
29+
This will create a new branch called `example-branch` based on the latest commit to `main`. Now you can start making your changes.
3030

3131
Any changes you plan to contribute should be sure to follow the project's style guide, testing structure, and be up-to-date with documentation.
3232

3333
### linting
34-
First you'll need to make sure your code style matches the rest of `cdippy` by using the `flake8` linter to check for adherance to the [PEP8](https://peps.python.org/pep-0008/) style guide:
34+
First you'll need to make sure your code style matches the rest of `cdippy` by using the `flake8` linter to check for adherence to the [PEP8](https://peps.python.org/pep-0008/) style guide:
3535
```bash
3636
flake8 .
3737
```
38-
If this commnad is successful, your style is up to date! Otherwise, the output will indicate where in the project the style is not compliant. You can manually fix these style deviations, or use a tool like [`black`](https://black.readthedocs.io/en/stable/) to autolint:
38+
If this command is successful, your style is up to date! Otherwise, the output will indicate where in the project the style is not compliant. You can manually fix these style deviations, or use a tool like [`black`](https://black.readthedocs.io/en/stable/) to autolint:
3939
```bash
4040
black .
4141
```
4242

43-
This project also provides a [`pre-commit`](https://pre-commit.com/) hook to manage style for you autmatically on every `git commit`. From the porject root:
43+
This project also provides a [`pre-commit`](https://pre-commit.com/) hook to manage style for you automatically on every `git commit`. From the project root:
4444
```bash
4545
pre-commit install
4646
```

docs/dev_guide/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ You'll specifically want to look at configuring credentials with [https](https:/
1515
## Install with dev tools
1616
It is recommended to us [`uv`](https://docs.astral.sh/uv/) to manage you development environment for this project, but other package managers will likely work as well. This documentation provides instructions for using `uv`.
1717

18-
Navigate to the project root dirctory ('CDIPpy/') and run the following:
18+
Navigate to the project root directory ('CDIPpy/') and run the following:
1919
``` bash
20-
>>> pip install uv # install uv pacakge manager
21-
>>> uv sync # create a virtual envionment at CDIPpy/.venv/, install the source code, its runtime dependencies and it's dev dependencies defined in pyproject.toml.
20+
>>> pip install uv # install uv package manager
21+
>>> uv sync # create a virtual environment at CDIPpy/.venv/, install the source code, its runtime dependencies and it's dev dependencies defined in pyproject.toml.
2222
>>> source .venv/bin/activate # activate the environment
2323
```
24-
To exclude the development dpendancies, you can run `uv sync --no-dev`.
24+
To exclude the development dependencies, you can run `uv sync --no-dev`.
2525

2626
### testing
2727
You can check that your dev installation was successful by running unit tests from the root directory: `python -m unittest discover`.
@@ -30,6 +30,6 @@ This runs every test in the library; you should see all successful tests.
3030
Learn more about running specific tests or subsets from the [`unittest` docs](https://docs.python.org/3/library/unittest.html).
3131

3232
### linting
33-
This library uses `flake8` to check for adherance to the [PEP8](https://peps.python.org/pep-0008/) style guide. To check whether your code is compliant with the project style, run `flake8 .` from the project root. You can fix problems manually, or use a tool like [`black`](https://black.readthedocs.io/en/stable/) to autolint: `black .`.
33+
This library uses `flake8` to check for adherence to the [PEP8](https://peps.python.org/pep-0008/) style guide. To check whether your code is compliant with the project style, run `flake8 .` from the project root. You can fix problems manually, or use a tool like [`black`](https://black.readthedocs.io/en/stable/) to autolint: `black .`.
3434

35-
This project also provides a [`pre-commit`](https://pre-commit.com/) hook to manage style for you autmatically on every `git commit`. To install it, run `pre-commit install` from the project root - this will use `black` and `flake` to autolint and check any changes you make for style before committing them to the repository.
35+
This project also provides a [`pre-commit`](https://pre-commit.com/) hook to manage style for you automatically on every `git commit`. To install it, run `pre-commit install` from the project root - this will use `black` and `flake` to autolint and check any changes you make for style before committing them to the repository.

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ CDIPpy is python library for navigating and accessing products provided by the [
44
A goal of publishing this library as an open source, contributable package is to foster closer collaboration between CDIP and the community of users.
55

66
## Navigating these docs
7-
The CDIP user community spans a brooad expertise and vastly different backgrounds in python development and usage - use the following guidelines to determine where to start in the documentation:
7+
The CDIP user community spans a broad expertise and vastly different backgrounds in python development and usage - use the following guidelines to determine where to start in the documentation:
88

99
* If you are relatively comfortable working with python, visit the [Quickstart Guide](quickstart.md).
1010
* If you would like more explicit, step-by-step instructions for:

docs/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ To view the coverage report:
3939
Contributions are welcome and should be merged via pull request on the `main` branch from a forked repository. Before a PR can be merged, it needs to pass the following checks:
4040

4141
* all tests passed
42-
* coverage >= threshhold
42+
* coverage >= threshold
4343
* passes [`flake8`](https://flake8.pycqa.org/en/latest/) linter
4444
* there must be at least one reviewer approval
4545
* a CLA must be signed by the contributor, if this is their first commit

0 commit comments

Comments
 (0)