Skip to content

Commit

Permalink
Merge branch 'main' into more-types
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewj-brown authored Jul 1, 2023
2 parents 7c96ffb + 0d049e9 commit 03fa95a
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,26 @@ We use an automated code formatter called [Black](https://black.readthedocs.io/)
poetry run black uqcsbot
```

Individual files can also be styled with:

```bash
poetry run pyright uqcsbot/file.py
```

## Static Type Checks

We use [Pyright](https://github.com/microsoft/pyright) to perform static type checks; which all commits should pass. The exception list within `pyproject.toml` is only to be used for legacy code or libraries with no available typing stubs. We hope that all new cogs can be made to pass - if you're having trouble, ping us on discord and we'll give you a hand. To run Pyright, run from the root of the repo:

```bash
poetry run pyright uqcsbot
```

Individual files can also be typechecked with:

```bash
poetry run pyright uqcsbot/file.py
```

## Development Resources

If this is your first time working on an open source project, we're here to walk you through every step of the way.
Expand Down

0 comments on commit 03fa95a

Please sign in to comment.