Skip to content

Latest commit

 

History

History
57 lines (31 loc) · 3.79 KB

CONTRIBUTING.md

File metadata and controls

57 lines (31 loc) · 3.79 KB

Contributing

Thanks for being here and for being awesome! 👍

The following sections outline the different ways to contribute to the project.

Discussing

The easiest way to contribute to the project is by participating in GitHub discussions. The community often chimes in with helpful advice when you have a question, and you may also find yourself providing answers and helping others. Be sure to review the code of conduct before participating.

Please do not use GitHub issues to ask a question. We will politely close a GitHub issue that asks a question and kindly refer you to one of the aforementioned avenues.

Reporting Bugs

We're sorry if this happened to you! Consider jumping into GitHub discussions first. The community may have already found a solution.

You can create a GitHub issue to report bugs. You can also create an official support request if you have a specific question that should be answered by a team member.

Requesting Features

We love a good idea. Do you have one? Consider jumping into GitHub discussions first. The community may have some interesting insights.

You can create a GitHub issue to request new features.

Reporting Security Vulnerabilities

We take security seriously, and we appreciate your cooperation in disclosing vulnerabilities to us responsibly. Refer to our security policy for more details.

Please do not use public GitHub issues to report a security vulnerability.

Changing Code

Interested in changing the world?

First, identify the scale of your proposed changes. If it is a small change, such as to fix grammar or spelling, feel free to start working on a fix. However, if it is a feature or substantial code contribution, please discuss it with the team first to ensure it fits in the product roadmap.

You can propose code changes by submitting GitHub pull requests. The code changes are expected to fit existing code styles and conventions. Using Visual Studio Code with the recommended extensions should minimize any manual work associated with code styles (see Setting Up a Development Environment).

Additionally, please consider taking a moment to read Miguel de Icaza's blog post titled Open Source Contribution Etiquette and Ilya Grigorik's blog post titled Don't "Push" Your Pull Requests.

Setting Up a Development Environment

First, you're going to need a few development tools:

We try to stay on the latest, stable versions of these tools, and we recommend that you choose to do the same. We will be unable to provide technical support for these tools, and old versions may not work with our project configuration.

Next, launch Visual Studio Code and install the following essential extensions:

Refer to the Visual Studio Code documentation for help finding and installing these extensions.