Skip to content

Commit 03c787b

Browse files
authored
Merge pull request #516 from soham4abc/main
command line instructions moved up
2 parents c5fda5d + d70d90c commit 03c787b

File tree

2 files changed

+30
-25
lines changed

2 files changed

+30
-25
lines changed

pydis_site/apps/content/resources/guides/pydis-guides/contributing/cloning-repository.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,29 @@ icon: fab fa-github
66

77
> **Note:** The process varies depending on your choice of code editor / IDE, so refer to one of the following guides:
88
9-
- [Cloning with PyCharm](#cloning-with-pycharm)
109
- [Cloning with the command line](#cloning-with-the-command-line)
10+
- [Cloning with PyCharm](#cloning-with-pycharm)
1111

1212
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).
1313

1414
---
1515

16-
## Cloning with PyCharm
17-
1. Load up PyCharm and click `Get from VCS`.<br>
18-
![Create Project in PyCharm](/static/images/content/contributing/pycharm_create_project.png)
19-
2. Enter the URL of your forked repository.
20-
3. Change the directory if you desire and click `Clone`.<br>
21-
![Clone Git Project in Pycharm](/static/images/content/contributing/pycharm_checkout.png)
22-
23-
---
24-
2516
## Cloning with the command line
17+
2618
1. Clone your forked repository using `git clone` followed by your fork's Git URL. Then, change your working directory to the repository.
19+
2720
```shell
2821
$ git clone https://github.com/<your username>/sir-lancebot
2922
...
3023
$ cd sir-lancebot
3124
```
25+
26+
---
27+
28+
## Cloning with PyCharm
29+
30+
1. Load up PyCharm and click `Get from VCS`.<br>
31+
![Create Project in PyCharm](/static/images/content/contributing/pycharm_create_project.png)
32+
2. Enter the URL of your forked repository.
33+
3. Change the directory if you desire and click `Clone`.<br>
34+
![Clone Git Project in Pycharm](/static/images/content/contributing/pycharm_checkout.png)

pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,36 @@ icon: fab fa-python
66

77
> **Note:** The process varies depending on your choice of code editor / IDE, so refer to one of the following guides:
88
9-
- [Installing dependencies with PyCharm](#installing-dependencies-with-pycharm)
109
- [Installing dependencies with the command line](#installing-dependencies-with-the-command-line)
10+
- [Installing dependencies with PyCharm](#installing-dependencies-with-pycharm)
1111

1212
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.
1313
You should have already cloned your fork as described in [**Cloning a Repository**](../cloning-repository).
1414

1515
---
1616

17-
## Installing dependencies with PyCharm
18-
1. Load up your project in PyCharm.
19-
2. Go to the Project Settings by clicking `File`, then `Settings...`. Alternatively, use the shortcut key: `Ctrl+Alt+S` (`command+comma` on Mac OS).
20-
3. Install the [poetry plugin](https://plugins.jetbrains.com/plugin/14307-poetry).
21-
4. Navigate to `Project Interpreter`, then click the gear icon and click `Add`.<br/>
22-
![PyCharm Interpreter Settings](/static/images/content/contributing/pycharm_interpreter.png)<br/>
23-
5. Click `Poetry Environment`, then click `OK`.<br/>
24-
![PyCharm Poetry Environment](/static/images/content/contributing/pycharm_poetry.png)<br/>
25-
6. PyCharm will automatically install the packages required into a virtual environment.<br/>
26-
![PyCharm Project Interpreter](/static/images/content/contributing/pycharm_poetry_success.png)
27-
28-
---
29-
3017
## Installing dependencies with the command line
18+
3119
1. Make sure you are in the root project directory. This directory will always have a file titled `README.md`.
3220
2. Install project and development dependencies. Remember to also set up pre-commit hooks to ensure your pushed commits will never fail linting.
33-
---
3421

22+
---
3523

3624
```shell
3725
$ poetry install
3826
$ poetry run task precommit
3927
```
28+
29+
---
30+
31+
## Installing dependencies with PyCharm
32+
33+
1. Load up your project in PyCharm.
34+
2. Go to the Project Settings by clicking `File`, then `Settings...`. Alternatively, use the shortcut key: `Ctrl+Alt+S` (`command+comma` on Mac OS).
35+
3. Install the [poetry plugin](https://plugins.jetbrains.com/plugin/14307-poetry).
36+
4. Navigate to `Project Interpreter`, then click the gear icon and click `Add`.<br/>
37+
![PyCharm Interpreter Settings](/static/images/content/contributing/pycharm_interpreter.png)<br/>
38+
5. Click `Poetry Environment`, then click `OK`.<br/>
39+
![PyCharm Poetry Environment](/static/images/content/contributing/pycharm_poetry.png)<br/>
40+
6. PyCharm will automatically install the packages required into a virtual environment.<br/>
41+
![PyCharm Project Interpreter](/static/images/content/contributing/pycharm_poetry_success.png)

0 commit comments

Comments
 (0)