Contributing¶

Thank you for your interest in contributing to the Docuisine project! This page and its children describe the ways you can contribute, as well as some of our policies. This should help guide you through your first Issue or PR.

Even if you cannot contribute code, you can still help Docuisine! The two main things you can help with are testing and creating issues. Contributing to code, documentation, and other non-code components are all outlined in the sections below.

Issues¶

We use GitHub extensively to track open issues, new enhancements or features, and other aspects of development.

Please see the getting help page for help with troubleshooting and finding bugs, and the documentation on issues for more information on how to submit good issues or solve them.

Developing Code¶

The entire project consists of a Python FastAPI backend server and a JavaScript ReactJS frontend web client. If you have experience with these languages, we're always grateful for any contributions you might want to make!

For general guidelines on how the project works, including how to set up your development copy, make changes, and guidelines on Pull Requests (PRs), please see the documentation on contributing code. Docuisine follows a "fork and PR" methodology; if you're not familiar with this, please see the relevant section.

Branding & Design¶

We are open to any changes regarding the branding, theme and User Interface design. For branding and theming, see the relevent documentation and submit PRs to this repository. For UI design, please submit PRs to this repository.

Adding To Documentation¶

Documentation is incredibly helpful! All these docs are written using Zensical. You can find the raw markdown in the documentation repository. Pull requests are welcome, though please review our documentation process first!

Testing¶

Testing is the easiest way to contribute. Simply use Docuisine, and if you run into problems, let us know. This is the most common way we uncover bugs, through a user doing something we hadn't thought about. If the issue does end up being related to the code, a bug issue can then be opened.

Repos¶

This section enumerates the repositories of Docuisine and are related with all the previously sections. Should you wish to contribute specifically to their repos, make sure to read their relevent documentation with respect to their domain.