Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

30 lines (22 loc) · 1.18 KB

Noomo

Thanks for your interest in Noomo ! Here is some guidelines and advices to help you contribute to the project.

Opening issues

If you encounter a bug or would like to see a new feature, you can open an issue ! Please make clear issues in English. If it is a bug, please provide reproductible steps and what the game should do instead.

Developing

Structure

This repository is structured with two main directories : Backend : The backend of the game, a FastAPI project using UV. Frontend : The frontend of the game, what you will see, made in HTML, JS and CSS. For dev instructions, please check the README.md in the Backend and Frontend folders

Liscencing

Please add this at the top of each file :

noomo - a llm predictions game
Copyright (C) 2026  skueee

Don't forget to comment it using the syntax of the programming language the file is being written with

Using AI

Using AI to help you understand something is okay, but please use AI as a tool to learn and not to write everything on your behalf.

It is recommended to tell if AI was used.

Please do not write issues or PR with AI. It's not a big deal if your English is not perfect. Mine is not either.