Skip to content

Commit e859efe

Browse files
authored
Merge pull request #619 from hedyhli/patch-1
Improve Gitpod section in Sir Lancebot contributing guide
2 parents b9f026a + 80d355d commit e859efe

File tree

1 file changed

+7
-2
lines changed
  • pydis_site/apps/content/resources/guides/pydis-guides/contributing

1 file changed

+7
-2
lines changed

pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,17 @@ toc: 1
1818

1919
## Using Gitpod
2020
Sir Lancebot can be edited and tested on Gitpod. Gitpod will automatically install the correct dependencies and Python version, so you can get straight to coding.
21-
To do this, you will need a Gitpod account, which you can get [here](https://www.gitpod.io/#get-started), and a fork of Sir Lancebot. This guide covers forking the repository [here](#fork-the-project). Afterwards, either click the button on Sir Lancebot's README or go to [https://gitpod.io/#/python-discord/sir-lancebot]() and run the following commands in the terminal:
21+
22+
To do this, you will need a Gitpod account, which you can get [here](https://www.gitpod.io/#get-started), and a fork of Sir Lancebot. This guide covers forking the repository [here](#fork-the-project).
23+
24+
Afterwards, click on [this link](https://gitpod.io/#/github.com/python-discord/sir-lancebot) to spin up a new workspace for Sir Lancebot. Then run the following commands in the terminal after the existing tasks have finished running:
2225
```sh
2326
git remote rename origin upstream
2427
git add remote origin https://github.com/{your_username}/sir-lancebot
2528
```
26-
Make sure you replace `{your_username}` with your Github username. These commands will set Python Discord as the parent repository, and your branch as the fork. This means you can easily grab new changes from the parent repository. Once you set your environment variables to test your code, you are ready to begin contributing to Sir Lancebot.
29+
Make sure you replace `{your_username}` with your Github username. These commands will set the Sir Lancebot repository as the secondary remote, and your fork as the primary remote. This means you can easily grab new changes from the main Sir Lancebot repository.
30+
31+
Once you've set up [a test server and bot account](#test-server-and-bot-account) and your [environment variables](#environment-variables), you are ready to begin contributing to Sir Lancebot!
2732

2833
## Using Docker
2934
Sir Lancebot can be started using Docker. Using Docker is generally recommended (but not strictly required) because it abstracts away some additional set up work.

0 commit comments

Comments
 (0)