diff options
2 files changed, 28 insertions, 23 deletions
diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/cloning-repository.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/cloning-repository.md index fad54374..1acb5400 100644 --- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/cloning-repository.md +++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/cloning-repository.md @@ -13,19 +13,22 @@ The following will use the [Sir-Lancebot](https://github.com/python-discord/sir- --- -## Cloning with PyCharm -1. Load up PyCharm and click `Get from VCS`.<br> - -2. Enter the URL of your forked repository. -3. Change the directory if you desire and click `Clone`.<br> - - ---- - ## Cloning with the command line + 1. Clone your forked repository using `git clone` followed by your fork's Git URL. Then, change your working directory to the repository. + ```shell $ git clone https://github.com/<your username>/sir-lancebot ... $ cd sir-lancebot ``` + +--- + +## Cloning with PyCharm + +1. Load up PyCharm and click `Get from VCS`.<br> +  +2. Enter the URL of your forked repository. +3. Change the directory if you desire and click `Clone`.<br> +  diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md index bd7efe67..ea991d15 100644 --- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md +++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md @@ -14,26 +14,28 @@ You should have already cloned your fork as described in [**Cloning a Repository --- -## Installing dependencies with PyCharm -1. Load up your project in PyCharm. -2. Go to the Project Settings by clicking `File`, then `Settings...`. Alternatively, use the shortcut key: `Ctrl+Alt+S` (`command+comma` on Mac OS). -3. Install the [poetry plugin](https://plugins.jetbrains.com/plugin/14307-poetry). -4. Navigate to `Project Interpreter`, then click the gear icon and click `Add`.<br/> -<br/> -5. Click `Poetry Environment`, then click `OK`.<br/> -<br/> -6. PyCharm will automatically install the packages required into a virtual environment.<br/> - - ---- - ## Installing dependencies with the command line + 1. Make sure you are in the root project directory. This directory will always have a file titled `README.md`. 2. Install project and development dependencies. Remember to also set up pre-commit hooks to ensure your pushed commits will never fail linting. ---- +--- ```shell $ poetry install $ poetry run task precommit ``` + +--- + +## Installing dependencies with PyCharm + +1. Load up your project in PyCharm. +2. Go to the Project Settings by clicking `File`, then `Settings...`. Alternatively, use the shortcut key: `Ctrl+Alt+S` (`command+comma` on Mac OS). +3. Install the [poetry plugin](https://plugins.jetbrains.com/plugin/14307-poetry). +4. Navigate to `Project Interpreter`, then click the gear icon and click `Add`.<br/> + <br/> +5. Click `Poetry Environment`, then click `OK`.<br/> + <br/> +6. PyCharm will automatically install the packages required into a virtual environment.<br/> +  |