TandoorRecipes/docs/contribute.md

If you like this application and want it to improve, feel free to contribute to its development.

!!! success "Contribution List" If you help bring this project forward you deserve to be credited for it. Feel free to add yourself to CONTRIBUTERS.md or message me to add you if you have contributed anything.

Issues

The most basic but also very important way of contributing is reporting issues and commenting on ideas and feature requests over on the GitHub issues.

Without Feedback improvement can't happen, so don't hesitate to say what you want to say.

Contributing Code

Code contributions are always welcome. There is no special rules for what you need to do, just do your best and we will work together to get your idea and code merged into the project.

Getting Started

This application is developed using the Django framework for Python. They have excellent documentation on how to get started, so I will only give you the basics here.

1. Clone this repository wherever you like and install the Python language for your OS (at least version 3.8)
2. Open it in your favorite editor/IDE (e.g. PyCharm)
   1. If you want, create a virutal environment for all your packages.
3. Install all required packages: pip install -r requirements.txt
4. Run the migrations: python manage.py migrate
5. Start the development server: python manage.py runserver

There is no need to set any environment variables. By default, a simple sqlite database is used and all settings are populated from default values.

Contribute Translations

If you know any foreign languages that is not yet translated feel free to contribute translations.

There is a transifex project project where you can get started. If you want to contribute a new language or help maintain an already existing one feel free to create a transifex account (using the link above) and request to join the project.

!!! warning "Transifex Requests" The Team management, language creation and communication on transifex is very difficult for some reason. Because of this please have some patience when approving your requests or adding you to a team takes a while. Please also not that if you request a language you are not automatically in its translation team and you will need to make an additional request after I have accepted the language.

It is also possible to provide the translations directly by creating a new language using manage.py makemessages -l <language_code> -i venv. Once finished, simply open a PR with the changed files.