Skip to content

Commit

Permalink
fix callouts oops
Browse files Browse the repository at this point in the history
  • Loading branch information
wizzdom committed Nov 5, 2024
1 parent 2a66877 commit 80cae34
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
12 changes: 6 additions & 6 deletions docs/webgroup/blockbot.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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=<Discord bot token here>
```
```
TOKEN=<Discord bot token here>
```

4. Run `pip install -r requirements.txt` to install the required packages.
5. Start the bot by running `python3 -m src`.
Expand Down
4 changes: 2 additions & 2 deletions docs/webgroup/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ git add <files you changed>
git commit -m "<commit message>"
```

> [!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.
Expand All @@ -53,5 +53,5 @@ git commit -m "<commit message>"
![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.

0 comments on commit 80cae34

Please sign in to comment.