Skip to content

Latest commit

 

History

History
116 lines (68 loc) · 5.26 KB

CONTRIBUTING.md

File metadata and controls

116 lines (68 loc) · 5.26 KB
Raw

Contribution Guidelines

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.

Table of Contents

  1. Code of Conduct
  2. License
  3. Questions
  4. Feature Requests
  5. Reporting Bugs
  6. Contributing with Code
    1. Getting Started
    2. Finding an Issue
    3. Development Process
    4. Building the Project
    5. Testing
  7. About this document

Code of Conduct

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!

License

By participating in this project and submitting contributions, you agree to license your contributions under the project license.

Questions

If you have any support questions, please open a GitHub discussion. The GitHub issue tracker is not for support-related requests.

Feature 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.

Reporting Bugs

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.

Contributing with code

Working on your first open source project or pull request? Here are some helpful tutorials:

Getting Started

Option 1: Dev Container

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.

Option 2: Local install

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:

  1. Run npm run install from the root directory of the project.
  2. You are good to go!

Finding an Issue

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.

Development Process

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.

Building the Project

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.

Testing

If you add code you need to add tests! If your pull request reduces our test coverage because it lacks tests then it will be rejected.

Tests can be added in the tests subfolder of each of the plugins. As an example, please take a look at the tests which are already there.

You can then run tests with npm from the root directory:

npm run test

Or with the npm: test VSCode task. More about VSCode tasks here.

About this document

These contribution guidelines are adapted by the Embedded Artistry Templates. Licensing information about the original information of this document can be found here.