Hey, welcome! We love receiving contributions from our community, so thanks for stopping by! There are many ways to contribute, including submitting bug reports and feature requests, reviewing new submissions, or contributing code that can be incorporated into the project.
This document describes our development process. Following these guidelines shows that you respect the time and effort of the developers managing this project. In return, you will be shown respect in addressing your issue, reviewing your changes, and incorporating your contributions.
Before reading further, please note that:
Note
This repository depends on Google's Firebase Genkit. For issues and questions related to Genkit, please refer to instructions available in Genkit's repository.
By participating in this project, you agree to abide by our Code of Conduct. We expect all contributors to follow the Code of Conduct and to treat fellow humans with respect. Be kind with others!
By participating in this project and submitting contributions, you agree to license your contributions under the project license.
If you have any support questions, please open a GitHub discussion. The GitHub issue tracker is not for support-related requests.
Major Changes that you wish to contribute to the project should be discussed first in an GitHub issue that clearly outlines the changes and benefits of the feature.
Small Changes can directly be crafted and submitted to the GitHub Repository as a Pull Request.
If you discover a security vulnerability, do NOT open an issue. Email [email protected] instead.
Before you submit your issue, please search the issue archive - your issue might have already been identified or addressed.
If you find a bug in the source code, you can help us by submitting an issue or, even better, you can submit a Pull Request with a fix.
Working on your first open source project or pull request? Here are some helpful tutorials:
We provide the configuration files for a VSCode Dev Container. When opening the repository within the container, VSCode will automatically install all the dependencies for you.
You can read more about Dev Containers here.
If you want to develop locally, please make sure to have Node >=20 installed on you machine.
You can set up the local development environment as follows:
- Run
npm run installfrom the root directory of the project. - You are good to go!
The list of open feature requests and bugs can be found on our on our GitHub issue tracker. Pick an unassigned issue that you think you can accomplish and add a comment that you are attempting to do it.
If you are a first time contributor, we highly suggest to read the GitHub fork and pull-request process here.
We work directly in the main branch. In order to contribute to the project you can create a new branch starting from there.
When you are done, make sure to create a Pull Request with main as the base branch.
You can build the package with npm from the root directory:
npm run build
Or with the npm: build VSCode task. More about VSCode tasks here.
These contribution guidelines are adapted by the Embedded Artistry Templates. Licensing information about the original information of this document can be found here.