Loading CONTRIBUTING.md 0 → 100644 +19 −0 Original line number Diff line number Diff line # Contributing ## Formatting We use [Ruff](https://astral.sh/ruff) as a formatting tool. You can run it using `uv`: ```bash uv run ruff format . ``` **Your code will only be merged to `master` if it is correctly formatted.** We recommend formatting before every commit. ## Type Checking We use [mypy](https://www.mypy-lang.org/) to validate our type hints. You can run it using `uv`: ```bash uv run mypy . ``` README.md +5 −1 Original line number Diff line number Diff line Loading @@ -17,7 +17,7 @@ Aren't you tired of having to remember shortlinks or URLs for all the services o **Well, that is a thing of the past!** With Portal, all the services you need are now just a click away. ## Which services does Portal offer? ## Features - View lunch menu in the Zentralmensa, INF 304 - By default, it shows today's menu. After 15:00, it shows tomorrow's menu. Loading @@ -27,6 +27,10 @@ Aren't you tired of having to remember shortlinks or URLs for all the services o - Hopefully user-friendly interface - Links to services offered by Fachschaft, institute and university ## Contributing See the [Contributing Guide](./CONTRIBUTING.md) for more details on how to contribute. ---- If you are a rather visual learner, we also got you covered: Loading Loading
CONTRIBUTING.md 0 → 100644 +19 −0 Original line number Diff line number Diff line # Contributing ## Formatting We use [Ruff](https://astral.sh/ruff) as a formatting tool. You can run it using `uv`: ```bash uv run ruff format . ``` **Your code will only be merged to `master` if it is correctly formatted.** We recommend formatting before every commit. ## Type Checking We use [mypy](https://www.mypy-lang.org/) to validate our type hints. You can run it using `uv`: ```bash uv run mypy . ```
README.md +5 −1 Original line number Diff line number Diff line Loading @@ -17,7 +17,7 @@ Aren't you tired of having to remember shortlinks or URLs for all the services o **Well, that is a thing of the past!** With Portal, all the services you need are now just a click away. ## Which services does Portal offer? ## Features - View lunch menu in the Zentralmensa, INF 304 - By default, it shows today's menu. After 15:00, it shows tomorrow's menu. Loading @@ -27,6 +27,10 @@ Aren't you tired of having to remember shortlinks or URLs for all the services o - Hopefully user-friendly interface - Links to services offered by Fachschaft, institute and university ## Contributing See the [Contributing Guide](./CONTRIBUTING.md) for more details on how to contribute. ---- If you are a rather visual learner, we also got you covered: Loading
