diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6d6f31e..b639da6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,5 @@ @@ -8,6 +8,24 @@ SPDX-License-Identifier: MPL-2.0 For the development-setup, please check out the docs: [https://classquiz.de/docs/develop](https://classquiz.de/docs/develop) +## Coding guidelines +- _Try_ to use type hints (python) and TypeScript everwhere possible (for python `foo() -> dict` is better than nothing) + +### Frontend +- Follow the existing coding style + - CamelCase for classnames + - snake_case for function names, variables and everything else + - aka Rust-style +- Feel free to reduce complexity in the code you're already touching +- always make sure the frontend builds (`pnpm build`) as it catches most typos +- Stick to current design language +- Use premade Brown and GreyButton components + + +## AI Usage +- Feel free to use any AI help +- Please refrain from using coding agents + ## Formatting git-commits Please use [Gitmoji](https://gitmoji.dev/) to format your commits. @@ -21,7 +39,6 @@ Just do so. If it is a security-related bug, please contact me at [mawoka.eu/contact](https://mawoka.eu/contact). If not, just open an issue here on GitHub. -**Please try to reproduce the bug with the adblocker disabled**, so I will be able to see the bug in Sentry. ## Want to translate?