diff --git a/docs/webgroup/blockbot.md b/docs/webgroup/blockbot.md index 19993fd..3f3eb95 100644 --- a/docs/webgroup/blockbot.md +++ b/docs/webgroup/blockbot.md @@ -30,7 +30,7 @@ All bot files are under `src/`. ## Installation > [!TIP] -> Docker Compose for local development is highly reccommended. This is similar to how it is deployed on Redbrick. +> Docker Compose for local development is highly recommended. This is similar to how it is deployed on Redbrick. ### Discord Developer Portal @@ -51,16 +51,16 @@ As a prerequisite, you need to have an application registered on the Discord dev 1. `git clone` and `cd` into the [blockbot repository](https://github.com/redbrick/blockbot). 2. It is generally advised to work in a Python [virtual environment](https://docs.python.org/3/library/venv.html): - ```sh +```sh python3 -m venv .venv source .venv/bin/activate - ``` +``` 3. Rename `.env.sample` to `.env` inside the repo folder and fill in the environment variables with your secrets. e.g.: - ``` - TOKEN= - ``` +``` +TOKEN= +``` 4. Run `pip install -r requirements.txt` to install the required packages. 5. Start the bot by running `python3 -m src`. diff --git a/docs/webgroup/contributing.md b/docs/webgroup/contributing.md index 4095aad..2d9e0e3 100644 --- a/docs/webgroup/contributing.md +++ b/docs/webgroup/contributing.md @@ -37,7 +37,7 @@ git add git commit -m "" ``` -> [!NOTE] Tip +> [!TIP] > See [Writing Meaningful Commit Messages](https://reflectoring.io/meaningful-commit-messages/) - On GitHub, navigate to your fork repository and switch to the branch you created. @@ -53,5 +53,5 @@ git commit -m "" ![Pull Request page on GitHub](../res/pull-request.png) -> [!NOTE] Tip +> [!TIP] > For bigger contributions, it's advisable to open a draft pull request when you begin development so other maintainers (e.g. other members of webgroup) can review your changes and provide feedback as you work.