Skip to content

Commit

Permalink
Update project documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
seniorquico committed Sep 25, 2023
1 parent 0810598 commit bb29b4a
Show file tree
Hide file tree
Showing 15 changed files with 232 additions and 209 deletions.
4 changes: 4 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
* @SaladTechnologies/admins

# Administrators must approve changes to the code owners.
CODEOWNERS @SaladTechnologies/admins
75 changes: 75 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [`[email protected]`](mailto:[email protected]). All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of actions.

**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html). Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).

Community Impact guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
104 changes: 104 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
# Contributing

Thanks for being here and for being awesome! 👍

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

## :mega: Discussing

The easiest way to contribute to the project is by participating in discussions on the [SaladChefs Discord server](https://discord.gg/salad) or in the [SaladChefs Subreddit](https://www.reddit.com/r/SaladChefs/). 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](./CODE_OF_CONDUCT.md) before participating.

You can create a [support ticket](https://support.salad.com/article/216-how-to-create-a-support-ticket) if you have a specific question that should be answered by a team member.

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

## :bug: Reporting Bugs

We're sorry if this happened to you! Consider jumping into the `#community-support` channel on the [SaladChefs Discord server](https://discord.gg/salad) or the "Community Support" category in the [SaladChefs Subreddit](https://www.reddit.com/r/SaladChefs/) first. The community may have already found a solution.

You can create a [support ticket](https://support.salad.com/article/216-how-to-create-a-support-ticket) to report bugs or if you have a specific question that should be answered by a team member.

## :sparkles: Requesting Features

We love a good idea. Do you have one? Consider jumping into the `#feature-requests` channel on the [SaladChefs Discord server](https://discord.gg/salad) or the "Feature Requests" category in the [SaladChefs Subreddit](https://www.reddit.com/r/SaladChefs/) first. The community may have some interesting insights.

## :rotating_light: Reporting Security Vulnerabilities

We take security seriously, and we appreciate your cooperation in disclosing vulnerabilities to us responsibly. Refer to our [security policy](./SECURITY.md) for more details.

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

## :octocat: 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](#setting-up-a-development-environment)).

Additionally, please consider taking a moment to read Miguel de Icaza's blog post titled [Open Source Contribution Etiquette](https://tirania.org/blog/archive/2010/Dec-31.html) and Ilya Grigorik's blog post titled [Don't "Push" Your Pull Requests](https://www.igvita.com/2011/12/19/dont-push-your-pull-requests/).

### Setting Up a Development Environment

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

- [Git](https://www.git-scm.com/)
- [nvm](https://github.com/nvm-sh/nvm) (if you're on Linux or macOS) or [NVM for Windows](https://github.com/coreybutler/nvm-windows) (if you're on Windows)
- [Visual Studio Code](https://code.visualstudio.com/)

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:

- [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
- [ZipFS](https://marketplace.visualstudio.com/items?itemName=arcanis.vscode-zipfs)

Refer to the [Visual Studio Code documentation](https://code.visualstudio.com/docs/editor/extension-gallery) for help finding and installing these extensions.

### 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:

```sh
git clone [email protected]:SaladTechnologies/salad-applications.git
```

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, change the current working directory to the location of the cloned project and install Node.js using nvm:

```bash
cd salad-applications/packages/web-app
nvm install
nvm use
```

In a Command Prompt terminal on Windows, change the current working directory to the location of the cloned project and install Node.js using NVM for Windows:

```cmd
cd salad-applications\packages\web-app
set /p node_version= < .nvmrc
nvm install %node_version%
nvm use %node_version%
```

In a PowerShell terminal on Windows, change the current working directory to the location of the cloned project and install Node.js using NVM for Windows:

```ps
Set-Location -Path salad-applications\packages\web-app
$NodeVersion = Get-Content .nvmrc
& nvm install $NodeVersion
& nvm use $NodeVersion
```

Next, restore the project dependencies and tooling.

```sh
yarn install
```

Finally, open the project 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.
8 changes: 8 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<!--
Thanks for opening a pull request! Here are some tips:
- Review the contributing guidelines and code of conduct.
- If the work is incomplete, please open the pull request as a "Draft".
-->
18 changes: 18 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Security

## Reporting Security Vulnerabilities

We take security seriously, and we appreciate your cooperation in disclosing vulnerabilities to us responsibly.

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

Instead, please do one of the following:

- Open a GitHub security advisory on the [GitHub repository](https://github.com/SaladTechnologies/virtual-kubelet-saladcloud/security/advisories/new)
- Send an email to [`[email protected]`](mailto:[email protected])

Please include as much information as you can provide to help us better understand the nature and scope of the issue.

## Supported Versions

We only support the latest release of the Salad desktop app and web app. The desktop app will attempt to automatically update when a new version is published. The web app will automatically update every time the page is reloaded.
3 changes: 3 additions & 0 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Support

We use the [SaladChefs Discord server](https://discord.gg/salad) and the [SaladChefs Subreddit](https://www.reddit.com/r/SaladChefs/) for general chat and community-provided support for the Salad apps. 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](./CODE_OF_CONDUCT.md) before participating.
6 changes: 6 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version: 2
updates:
- package-ecosystem: npm
directory: /packages/web-app
schedule:
interval: weekly
6 changes: 1 addition & 5 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
{
"recommendations": [
"arcanis.vscode-zipfs",
"dbaeumer.vscode-eslint",
"editorconfig.editorconfig",
"esbenp.prettier-vscode",
"wayou.vscode-todo-highlight"
"editorconfig.editorconfig"
],
"unwantedRecommendations": []
}
30 changes: 0 additions & 30 deletions .vscode/launch.json

This file was deleted.

35 changes: 0 additions & 35 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,7 @@
"editor.minimap.maxColumn": 120,
"editor.renderWhitespace": "all",
"editor.rulers": [120],
"eslint.validate": [
"javascript",
"javascriptreact",
"html",
"typescript",
"typescriptreact"
],
"eslint.nodePath": "packages/web-app/.yarn/sdks",
"eslint.packageManager": "yarn",
"files.associations": {
".env.development.local": "properties",
".env.development": "properties",
".env.production.local": "properties",
".env.production": "properties",
".env.test.local": "properties",
".env.test": "properties",
".env": "properties"
},
"git.branchProtection": ["master"],
"javascript.format.enable": false,
"javascript.validate.enable": false,
"npm.packageManager": "yarn",
"prettier.prettierPath": "packages/web-app/.yarn/sdks/prettier/index.js",
"search.exclude": {
"node_modules": true,
"scripts": true,
Expand All @@ -34,18 +12,5 @@
"**/npm-debug.log*": true,
"**/yarn-debug.log*": true,
"**/yarn-error.log*": true
},
"typescript.enablePromptUseWorkspaceTsdk": true,
"typescript.format.enable": false,
"typescript.tsdk": "packages/web-app/.yarn/sdks/typescript/lib",
"[typescript]": {
"editor.codeActionsOnSave": {
"source.organizeImports": true
}
},
"[typescriptreact]": {
"editor.codeActionsOnSave": {
"source.organizeImports": true
}
}
}
1 change: 0 additions & 1 deletion CODEOWNERS

This file was deleted.

Loading

0 comments on commit bb29b4a

Please sign in to comment.