diff --git a/docs/dev_guide/contribute.md b/docs/dev_guide/contribute.md index e8b4e3b..a715e69 100644 --- a/docs/dev_guide/contribute.md +++ b/docs/dev_guide/contribute.md @@ -9,8 +9,8 @@ Thank you for considering making a contribution to CDIPpy! We welcome all types ## Setting up your git workflow 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: -1. Fork the respository at [https://github.com/cdipsw/CDIPpy/fork](https://github.com/cdipsw/CDIPpy/fork) -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.* +1. Fork the repository at [https://github.com/cdipsw/CDIPpy/fork](https://github.com/cdipsw/CDIPpy/fork) +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.* 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: ```bash 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 git pull git checkout -b example-branch ``` -This will create a new branch called `example-branch` based on the lastest commit to `main`. Now you can start making your changes. +This will create a new branch called `example-branch` based on the latest commit to `main`. Now you can start making your changes. 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. ### linting -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: +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: ```bash flake8 . ``` -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: +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: ```bash black . ``` -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: +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: ```bash pre-commit install ``` diff --git a/docs/dev_guide/index.md b/docs/dev_guide/index.md index 0875699..acf8e39 100644 --- a/docs/dev_guide/index.md +++ b/docs/dev_guide/index.md @@ -15,13 +15,13 @@ You'll specifically want to look at configuring credentials with [https](https:/ ## Install with dev tools 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`. -Navigate to the project root dirctory ('CDIPpy/') and run the following: +Navigate to the project root directory ('CDIPpy/') and run the following: ``` bash ->>> pip install uv # install uv pacakge manager ->>> 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. +>>> pip install uv # install uv package manager +>>> 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. >>> source .venv/bin/activate # activate the environment ``` -To exclude the development dpendancies, you can run `uv sync --no-dev`. +To exclude the development dependencies, you can run `uv sync --no-dev`. ### testing 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. Learn more about running specific tests or subsets from the [`unittest` docs](https://docs.python.org/3/library/unittest.html). ### linting -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 .`. +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 .`. -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. +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. diff --git a/docs/index.md b/docs/index.md index 44a1cf6..23d9559 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,7 +4,7 @@ CDIPpy is python library for navigating and accessing products provided by the [ A goal of publishing this library as an open source, contributable package is to foster closer collaboration between CDIP and the community of users. ## Navigating these docs -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: +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: * If you are relatively comfortable working with python, visit the [Quickstart Guide](quickstart.md). * If you would like more explicit, step-by-step instructions for: diff --git a/docs/quickstart.md b/docs/quickstart.md index e1437df..e7b31e5 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -39,7 +39,7 @@ To view the coverage report: 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: * all tests passed -* coverage >= threshhold +* coverage >= threshold * passes [`flake8`](https://flake8.pycqa.org/en/latest/) linter * there must be at least one reviewer approval * a CLA must be signed by the contributor, if this is their first commit