Skip to content

Latest commit

 

History

History
106 lines (65 loc) · 5 KB

CONTRIBUTING.md

File metadata and controls

106 lines (65 loc) · 5 KB
Raw

Contributing

Thanks for being here and for being awesome! 👍

Table of Contents

Discussing

The easiest way to contribute to Salad is by participating in discussions on our community forums or the SaladChefs Discord server. The community often chimes in with helpful advice when you have a question, and you may also find yourself providing answers and helping others.

You can also create a support ticket if you have a specific question that should be answered by a team member.

Please don't 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 the Community Support category on our community forums or the #community-support channel in the SaladChefs Discord server. The community may have already found a solution.

You can also create a support ticket to report any problems or concerns.

Requesting Features

We love a good idea. Do you have one?

Consider jumping into the Feature Requests category on our community forums. You may submit your ideas or upvote existing suggestions there. The community may have some interesting insights.

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.

Next, use nvm (if you're on Linux or macOS) or NVM for Windows (if you're on Windows) to install the required version of Node.js.

In a Bash terminal on Linux or macOS:

nvm install
nvm use

In a Command Prompt terminal on Windows:

set /p node_version= < .nvmrc
nvm install %node_version%
nvm use %node_version%

In a PowerShell terminal on Windows:

$NodeVersion = Get-Content .nvmrc
& nvm install $NodeVersion
& nvm use $NodeVersion

Setting Up the Project

First, you're going to need to clone the repository.

In your favorite terminal, change the current working directory to a location suitable for storing the repository. Then run the following:

git clone https://github.com/SaladTechnologies/salad-applications.git

Next, restore the project dependencies and tooling.

In your favorite terminal, change the current working directory to the location of the cloned repository. Then run the following:

yarn install

Finally, open the location of the cloned repository in Visual Studio Code. Use Ctrl+Shift+P to open the command palette. Choose the "Select TypeScript Version" command, and choose the "Use Workspace Version" option.