Before contributing, please check out our Code of Conduct and Contribution guidelines.
We expect to see submissions on these topics:
If you have a bug to report or a feature to request, please fill an issue.
If you want to add new widgets to DebiAI, please follow the widget creation guide.
If you want to contribute, navigate to the Github "issues" tab and start looking through interesting issues. If you are not sure of where to start, then start by trying one of the smaller/easier issues here i.e. issues with the "good first issue" label.
If you decide to start on an issue, leave a comment so we and other people know that you're working on it, we will be happy to help.
Feel free to share your experience on your use cases with DebiAI on the community discussions.
There is two ways to submit your contribution to DebiAI, you can either fork the repository or have your own branch on the DebiAI repository.
If both cases, to submit your code, please make a pull request to our main branch. For those just getting started, Github has a how to about pull requests.
You will be asked to sign our CLA (Contributing License Agreement) before we can merge your code. Please read it before you start working on the project.
A DebiAI team members will then be assigned to review your pull request. Once the pull request is approved, your changes will be merged.
To add changes, you can fork the repository and submit your contribution by creating a pull request.
Here is a complete guide on how to contribute by forking.
If you don't want to fork the project, we allow contributors to have their own branch in the repository. Before being able to create a branch, you will need to be added as a contributor to the repository. You can do this by asking us at [email protected], on a discussion or by commenting on an issue.
Make sure your changes are consistent with the guidelines and follow the DebiAI coding style:
- debiai/backend: Try to implement the unitary tests if applicable.