From 4158e52375c0c47fd29cfc18be3b19e8e6939541 Mon Sep 17 00:00:00 2001 From: Soham Banerjee Date: Mon, 31 May 2021 16:13:50 +0530 Subject: command line instructions moved up --- .../contributing/cloning-repository.md | 21 ++++++++------- .../installing-project-dependencies.md | 30 ++++++++++++---------- 2 files changed, 28 insertions(+), 23 deletions(-) (limited to 'pydis_site') 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`.
-![Create Project in PyCharm](/static/images/content/contributing/pycharm_create_project.png) -2. Enter the URL of your forked repository. -3. Change the directory if you desire and click `Clone`.
-![Clone Git Project in Pycharm](/static/images/content/contributing/pycharm_checkout.png) - ---- - ## 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//sir-lancebot ... $ cd sir-lancebot ``` + +--- + +## Cloning with PyCharm + +1. Load up PyCharm and click `Get from VCS`.
+ ![Create Project in PyCharm](/static/images/content/contributing/pycharm_create_project.png) +2. Enter the URL of your forked repository. +3. Change the directory if you desire and click `Clone`.
+ ![Clone Git Project in Pycharm](/static/images/content/contributing/pycharm_checkout.png) 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`.
-![PyCharm Interpreter Settings](/static/images/content/contributing/pycharm_interpreter.png)
-5. Click `Poetry Environment`, then click `OK`.
-![PyCharm Poetry Environment](/static/images/content/contributing/pycharm_poetry.png)
-6. PyCharm will automatically install the packages required into a virtual environment.
-![PyCharm Project Interpreter](/static/images/content/contributing/pycharm_poetry_success.png) - ---- - ## 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`.
+ ![PyCharm Interpreter Settings](/static/images/content/contributing/pycharm_interpreter.png)
+5. Click `Poetry Environment`, then click `OK`.
+ ![PyCharm Poetry Environment](/static/images/content/contributing/pycharm_poetry.png)
+6. PyCharm will automatically install the packages required into a virtual environment.
+ ![PyCharm Project Interpreter](/static/images/content/contributing/pycharm_poetry_success.png) -- cgit v1.2.3 From d70d90c1f34f7dd2dbfdd63c2edac1ac05a5a5af Mon Sep 17 00:00:00 2001 From: Soham Banerjee Date: Mon, 31 May 2021 16:57:50 +0530 Subject: table of contents updated --- .../resources/guides/pydis-guides/contributing/cloning-repository.md | 2 +- .../guides/pydis-guides/contributing/installing-project-dependencies.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'pydis_site') 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 1acb5400..23d525b8 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 @@ -6,8 +6,8 @@ icon: fab fa-github > **Note:** The process varies depending on your choice of code editor / IDE, so refer to one of the following guides: -- [Cloning with PyCharm](#cloning-with-pycharm) - [Cloning with the command line](#cloning-with-the-command-line) +- [Cloning with PyCharm](#cloning-with-pycharm) The following will use the [Sir-Lancebot](https://github.com/python-discord/sir-lancebot/) repository as an example, but the steps are the same for all other repositories. You should have already retrieved your fork's Git URL as described in [**Creating a Fork**](../forking-repository). 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 ea991d15..26d6de30 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 @@ -6,8 +6,8 @@ icon: fab fa-python > **Note:** The process varies depending on your choice of code editor / IDE, so refer to one of the following guides: -- [Installing dependencies with PyCharm](#installing-dependencies-with-pycharm) - [Installing dependencies with the command line](#installing-dependencies-with-the-command-line) +- [Installing dependencies with PyCharm](#installing-dependencies-with-pycharm) The following will use the [Sir-Lancebot](https://github.com/python-discord/sir-lancebot/) repository as an example, but the steps are the same for all other repositories. You should have already cloned your fork as described in [**Cloning a Repository**](../cloning-repository). -- cgit v1.2.3