470486104/Server
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
b5416ceba7
Server/README.md

123 lines
7.7 KiB
Markdown
Raw Normal View History

Updates Server README (!306) - Updates the Server project README to include additional information about installation, development, and contribuation guidelines. - Moves the feature list to a dedicated FEATURE.md file (linked from the README.md). - Reviewed the FEATURES.md file to clean it up a little bit. Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/306 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-04-25 19:26:47 +02:00
# Single Player Tarkov - Server Project
This is the Server project for the Single Player Tarkov mod for Escape From Tarkov. It can be run locally to replicate responses to the modified Escape From Tarkov client.
# Table of Contents
- [Features](#features)
- [Installation](#installation)
Linting Updates (!336) This update now runs Prettier before ESLint (with the Stylistic plugin) for code formatting. This takes care of a lot of the edge cases that ESLint doesn't touch by itself. Also adds the `eslint-plugin-unused-imports` ESLint plugin to remove unused imports and the `eslint-plugin-switch-allman` ESLint plugin to enforce Allman braces on case declarations. The VSCode format-on-save function now requires two additional extentions to be installed: Prettier and Format Code Action. Links can be found in the README and in the recommended extentions section of VSCode when the workspace is open. Co-authored-by: chomp <chomp@noreply.dev.sp-tarkov.com> Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/336 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-05-16 10:41:05 +02:00
- [Requirements](#requirements)
- [Initial Setup](#initial-setup)
Updates Server README (!306) - Updates the Server project README to include additional information about installation, development, and contribuation guidelines. - Moves the feature list to a dedicated FEATURE.md file (linked from the README.md). - Reviewed the FEATURES.md file to clean it up a little bit. Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/306 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-04-25 19:26:47 +02:00
- [Development](#development)
Linting Updates (!336) This update now runs Prettier before ESLint (with the Stylistic plugin) for code formatting. This takes care of a lot of the edge cases that ESLint doesn't touch by itself. Also adds the `eslint-plugin-unused-imports` ESLint plugin to remove unused imports and the `eslint-plugin-switch-allman` ESLint plugin to enforce Allman braces on case declarations. The VSCode format-on-save function now requires two additional extentions to be installed: Prettier and Format Code Action. Links can be found in the README and in the recommended extentions section of VSCode when the workspace is open. Co-authored-by: chomp <chomp@noreply.dev.sp-tarkov.com> Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/336 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-05-16 10:41:05 +02:00
- [Commands](#commands)
- [Debugging](#debugging)
- [Mod Debugging](#mod-debugging)
Updates Server README (!306) - Updates the Server project README to include additional information about installation, development, and contribuation guidelines. - Moves the feature list to a dedicated FEATURE.md file (linked from the README.md). - Reviewed the FEATURES.md file to clean it up a little bit. Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/306 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-04-25 19:26:47 +02:00
- [Contributing](#contributing)
Linting Updates (!336) This update now runs Prettier before ESLint (with the Stylistic plugin) for code formatting. This takes care of a lot of the edge cases that ESLint doesn't touch by itself. Also adds the `eslint-plugin-unused-imports` ESLint plugin to remove unused imports and the `eslint-plugin-switch-allman` ESLint plugin to enforce Allman braces on case declarations. The VSCode format-on-save function now requires two additional extentions to be installed: Prettier and Format Code Action. Links can be found in the README and in the recommended extentions section of VSCode when the workspace is open. Co-authored-by: chomp <chomp@noreply.dev.sp-tarkov.com> Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/336 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-05-16 10:41:05 +02:00
- [Branches](#branchs)
- [Pull Request Guidelines](#pull-request-guidelines)
- [Tests](#tests)
Updates Server README (!306) - Updates the Server project README to include additional information about installation, development, and contribuation guidelines. - Moves the feature list to a dedicated FEATURE.md file (linked from the README.md). - Reviewed the FEATURES.md file to clean it up a little bit. Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/306 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-04-25 19:26:47 +02:00
- [License](#license)
## Features
For a full list of features, please see [FEATURES.md](FEATURES.md).
## Installation
### Requirements
This project has been built in [Visual Studio Code](https://code.visualstudio.com/) (VSC) using [Node.js](https://nodejs.org/). We recommend using [NVM](https://github.com/coreybutler/nvm-windows) to manage installation and switching Node versions. If you do not wish to use NVM, you will need to install the version of Node.js listed within the `.nvmrc` file manually.
There are a number of VSC extensions that we recommended for this project. VSC will prompt you to install these when you open the workspace file. If you do not see the prompt, you can install them manually:
- [EditorConfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) - Editor Settings Synchronization
- [Vitest](https://marketplace.visualstudio.com/items?itemName=vitest.explorer) - Debugging Tests
- [SPT ID Highlighter](https://marketplace.visualstudio.com/items?itemName=refringe.spt-id-highlighter) - Converts IDs to Names
Linting Updates (!336) This update now runs Prettier before ESLint (with the Stylistic plugin) for code formatting. This takes care of a lot of the edge cases that ESLint doesn't touch by itself. Also adds the `eslint-plugin-unused-imports` ESLint plugin to remove unused imports and the `eslint-plugin-switch-allman` ESLint plugin to enforce Allman braces on case declarations. The VSCode format-on-save function now requires two additional extentions to be installed: Prettier and Format Code Action. Links can be found in the README and in the recommended extentions section of VSCode when the workspace is open. Co-authored-by: chomp <chomp@noreply.dev.sp-tarkov.com> Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/336 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-05-16 10:41:05 +02:00
- [Format Code Action](https://marketplace.visualstudio.com/items?itemName=rohit-gohri.format-code-action) - Custom Format-on-save Actions
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) - Code Formatting
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - Linting for Coding Issues & Naming Conventions
Updates Server README (!306) - Updates the Server project README to include additional information about installation, development, and contribuation guidelines. - Moves the feature list to a dedicated FEATURE.md file (linked from the README.md). - Reviewed the FEATURES.md file to clean it up a little bit. Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/306 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-04-25 19:26:47 +02:00
### Initial Setup
To prepare the project for development you will need to:
Updated readme
2024-05-21 20:05:12 +02:00
1. Run `git clone https://dev.sp-tarkov.com/SPT/Server.git server` to clone the repository.
Updates Server README (!306) - Updates the Server project README to include additional information about installation, development, and contribuation guidelines. - Moves the feature list to a dedicated FEATURE.md file (linked from the README.md). - Reviewed the FEATURES.md file to clean it up a little bit. Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/306 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-04-25 19:26:47 +02:00
2. Run `git lfs pull` to download LFS files locally.
Linting Updates (!336) This update now runs Prettier before ESLint (with the Stylistic plugin) for code formatting. This takes care of a lot of the edge cases that ESLint doesn't touch by itself. Also adds the `eslint-plugin-unused-imports` ESLint plugin to remove unused imports and the `eslint-plugin-switch-allman` ESLint plugin to enforce Allman braces on case declarations. The VSCode format-on-save function now requires two additional extentions to be installed: Prettier and Format Code Action. Links can be found in the README and in the recommended extentions section of VSCode when the workspace is open. Co-authored-by: chomp <chomp@noreply.dev.sp-tarkov.com> Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/336 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-05-16 10:41:05 +02:00
3. Open the `project/mod.code-workspace` file in Visual Studio Code (VSC).
Revert "Updated server node version to `20.14.0` from `20.11.1`" This reverts commit f672ad27bfc1b001e94867fffe8ad5da2d051712.
2024-06-03 18:34:22 +02:00
4. Run `nvm use 20.11.1` in the VSC terminal.
Linting Updates (!336) This update now runs Prettier before ESLint (with the Stylistic plugin) for code formatting. This takes care of a lot of the edge cases that ESLint doesn't touch by itself. Also adds the `eslint-plugin-unused-imports` ESLint plugin to remove unused imports and the `eslint-plugin-switch-allman` ESLint plugin to enforce Allman braces on case declarations. The VSCode format-on-save function now requires two additional extentions to be installed: Prettier and Format Code Action. Links can be found in the README and in the recommended extentions section of VSCode when the workspace is open. Co-authored-by: chomp <chomp@noreply.dev.sp-tarkov.com> Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/336 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-05-16 10:41:05 +02:00
5. Run `npm install` in the VSC terminal.
Updates Server README (!306) - Updates the Server project README to include additional information about installation, development, and contribuation guidelines. - Moves the feature list to a dedicated FEATURE.md file (linked from the README.md). - Reviewed the FEATURES.md file to clean it up a little bit. Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/306 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-04-25 19:26:47 +02:00
## Development
### Commands
The following commands are available after the initial setup. Run them with `npm run <command>`.
Linting Updates (!336) This update now runs Prettier before ESLint (with the Stylistic plugin) for code formatting. This takes care of a lot of the edge cases that ESLint doesn't touch by itself. Also adds the `eslint-plugin-unused-imports` ESLint plugin to remove unused imports and the `eslint-plugin-switch-allman` ESLint plugin to enforce Allman braces on case declarations. The VSCode format-on-save function now requires two additional extentions to be installed: Prettier and Format Code Action. Links can be found in the README and in the recommended extentions section of VSCode when the workspace is open. Co-authored-by: chomp <chomp@noreply.dev.sp-tarkov.com> Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/336 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-05-16 10:41:05 +02:00
| Command | Description |
| -------------------- | ----------------------------------------------------------------------------- |
| `check:circular` | Check for circular dependencies in the project. |
| `lint` | Check the project for coding standards and post-Prettier formatting issues. |
| `lint:fix` | Automatically fix coding standard issues and post-Prettier formatting issues. |
| `style` | Check the project for coding standards and post-Prettier formatting issues. |
| `style:fix` | Automatically fix coding standard issues and post-Prettier formatting issues. |
| `format` | Run Prettier and then ESLint Stylistic to fix code formatting. |
| `test` | Run all tests. |
| `test:watch` | Run tests in watch mode. Tests will re-run when files are changed. |
| `test:coverage` | Run tests and generate a coverage report. |
| `test:ui` | Run tests in UI mode. This will open a browser window to view tests. |
| `build:release` | Build the project for release. |
| `build:debug` | Build the project for debugging. |
| `build:bleeding` | Build the project on the bleeding edge. |
| `build:bleedingmods` | Build the project on the bleeding edge with mods. |
| `run:build` | Run the project in build mode. |
| `run:debug` | Run the project in debug mode. |
| `run:profiler` | Run the project in profiler mode. |
| `gen:types` | Generate types for the project. |
| `gen:docs` | Generate documentation for the project. |
Updates Server README (!306) - Updates the Server project README to include additional information about installation, development, and contribuation guidelines. - Moves the feature list to a dedicated FEATURE.md file (linked from the README.md). - Reviewed the FEATURES.md file to clean it up a little bit. Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/306 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-04-25 19:26:47 +02:00
### Debugging
To debug the project in Visual Studio Code, you can select the `Run` tab and then select the `Start Debugging` option (or the `F5` shortcut). This will start the server in debug mode, attaching a debugger to code execution, allowing you to set breakpoints and step through the code as it runs.
### Mod Debugging
To debug a server mod in Visual Studio Code, you can copy the mod files into the `user/mods` folder and then start the server in [debug mode](#debugging). You should now be able to set breakpoints in the mod's Typescript files and they will be hit when the server runs the mod files.
Code Styling Changes - Drops DPrint - Drops Biome - Adds ESList Stylistic - Updates ESLint config to new FlatConfig format - Removed the `dprint.dprint` and `biomejs.biome` VSC extentions from the recommendations list - Updates README to reflect all the above changes TODO: Import sorting & minor fixes after `npm run lint:fix`. Curse you, Alex!
2024-05-06 08:35:06 +02:00
## Contributing
Updates Server README (!306) - Updates the Server project README to include additional information about installation, development, and contribuation guidelines. - Moves the feature list to a dedicated FEATURE.md file (linked from the README.md). - Reviewed the FEATURES.md file to clean it up a little bit. Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/306 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-04-25 19:26:47 +02:00
We're really excited that you're interested in contributing! Before submitting your contribution, please consider the following:
### Branchs
Linting Updates (!336) This update now runs Prettier before ESLint (with the Stylistic plugin) for code formatting. This takes care of a lot of the edge cases that ESLint doesn't touch by itself. Also adds the `eslint-plugin-unused-imports` ESLint plugin to remove unused imports and the `eslint-plugin-switch-allman` ESLint plugin to enforce Allman braces on case declarations. The VSCode format-on-save function now requires two additional extentions to be installed: Prettier and Format Code Action. Links can be found in the README and in the recommended extentions section of VSCode when the workspace is open. Co-authored-by: chomp <chomp@noreply.dev.sp-tarkov.com> Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/336 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-05-16 10:41:05 +02:00
- **master**
Updates Server README (!306) - Updates the Server project README to include additional information about installation, development, and contribuation guidelines. - Moves the feature list to a dedicated FEATURE.md file (linked from the README.md). - Reviewed the FEATURES.md file to clean it up a little bit. Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/306 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-04-25 19:26:47 +02:00
The default branch used for the latest stable release. This branch is protected and typically is only merges with release branches.
Linting Updates (!336) This update now runs Prettier before ESLint (with the Stylistic plugin) for code formatting. This takes care of a lot of the edge cases that ESLint doesn't touch by itself. Also adds the `eslint-plugin-unused-imports` ESLint plugin to remove unused imports and the `eslint-plugin-switch-allman` ESLint plugin to enforce Allman braces on case declarations. The VSCode format-on-save function now requires two additional extentions to be installed: Prettier and Format Code Action. Links can be found in the README and in the recommended extentions section of VSCode when the workspace is open. Co-authored-by: chomp <chomp@noreply.dev.sp-tarkov.com> Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/336 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-05-16 10:41:05 +02:00
- **3.9.0-DEV**
Updates Server README (!306) - Updates the Server project README to include additional information about installation, development, and contribuation guidelines. - Moves the feature list to a dedicated FEATURE.md file (linked from the README.md). - Reviewed the FEATURES.md file to clean it up a little bit. Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/306 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-04-25 19:26:47 +02:00
Development for the next minor release of SPT. Minor releases target the latest version of EFT. Late in the minor release cycle the EFT version is frozen for stability to prepare for release. Larger changes to the project structure may be included in minor releases.
Linting Updates (!336) This update now runs Prettier before ESLint (with the Stylistic plugin) for code formatting. This takes care of a lot of the edge cases that ESLint doesn't touch by itself. Also adds the `eslint-plugin-unused-imports` ESLint plugin to remove unused imports and the `eslint-plugin-switch-allman` ESLint plugin to enforce Allman braces on case declarations. The VSCode format-on-save function now requires two additional extentions to be installed: Prettier and Format Code Action. Links can be found in the README and in the recommended extentions section of VSCode when the workspace is open. Co-authored-by: chomp <chomp@noreply.dev.sp-tarkov.com> Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/336 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-05-16 10:41:05 +02:00
- **3.8.4-DEV**
Updates Server README (!306) - Updates the Server project README to include additional information about installation, development, and contribuation guidelines. - Moves the feature list to a dedicated FEATURE.md file (linked from the README.md). - Reviewed the FEATURES.md file to clean it up a little bit. Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/306 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-04-25 19:26:47 +02:00
Development for the next hotfix release of SPT. Hotfix releases include bug fixes and minor features that do not effect the coding structure of the project. Special care is taken to not break server mod stability. These always target the same version of EFT as the last minor release.
### Pull Request Guidelines
Linting Updates (!336) This update now runs Prettier before ESLint (with the Stylistic plugin) for code formatting. This takes care of a lot of the edge cases that ESLint doesn't touch by itself. Also adds the `eslint-plugin-unused-imports` ESLint plugin to remove unused imports and the `eslint-plugin-switch-allman` ESLint plugin to enforce Allman braces on case declarations. The VSCode format-on-save function now requires two additional extentions to be installed: Prettier and Format Code Action. Links can be found in the README and in the recommended extentions section of VSCode when the workspace is open. Co-authored-by: chomp <chomp@noreply.dev.sp-tarkov.com> Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/336 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-05-16 10:41:05 +02:00
- **Keep Them Small**
Updates Server README (!306) - Updates the Server project README to include additional information about installation, development, and contribuation guidelines. - Moves the feature list to a dedicated FEATURE.md file (linked from the README.md). - Reviewed the FEATURES.md file to clean it up a little bit. Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/306 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-04-25 19:26:47 +02:00
If you're fixing a bug, try to keep the changes to the bug fix only. If you're adding a feature, try to keep the changes to the feature only. This will make it easier to review and merge your changes.
Linting Updates (!336) This update now runs Prettier before ESLint (with the Stylistic plugin) for code formatting. This takes care of a lot of the edge cases that ESLint doesn't touch by itself. Also adds the `eslint-plugin-unused-imports` ESLint plugin to remove unused imports and the `eslint-plugin-switch-allman` ESLint plugin to enforce Allman braces on case declarations. The VSCode format-on-save function now requires two additional extentions to be installed: Prettier and Format Code Action. Links can be found in the README and in the recommended extentions section of VSCode when the workspace is open. Co-authored-by: chomp <chomp@noreply.dev.sp-tarkov.com> Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/336 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-05-16 10:41:05 +02:00
- **Perform a Self-Review**
Updates Server README (!306) - Updates the Server project README to include additional information about installation, development, and contribuation guidelines. - Moves the feature list to a dedicated FEATURE.md file (linked from the README.md). - Reviewed the FEATURES.md file to clean it up a little bit. Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/306 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-04-25 19:26:47 +02:00
Before submitting your changes, review your own code. This will help you catch any mistakes you may have made.
Linting Updates (!336) This update now runs Prettier before ESLint (with the Stylistic plugin) for code formatting. This takes care of a lot of the edge cases that ESLint doesn't touch by itself. Also adds the `eslint-plugin-unused-imports` ESLint plugin to remove unused imports and the `eslint-plugin-switch-allman` ESLint plugin to enforce Allman braces on case declarations. The VSCode format-on-save function now requires two additional extentions to be installed: Prettier and Format Code Action. Links can be found in the README and in the recommended extentions section of VSCode when the workspace is open. Co-authored-by: chomp <chomp@noreply.dev.sp-tarkov.com> Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/336 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-05-16 10:41:05 +02:00
- **Remove Noise**
Updates Server README (!306) - Updates the Server project README to include additional information about installation, development, and contribuation guidelines. - Moves the feature list to a dedicated FEATURE.md file (linked from the README.md). - Reviewed the FEATURES.md file to clean it up a little bit. Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/306 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-04-25 19:26:47 +02:00
Remove any unnecessary changes to white space, code style formatting, or some text change that has no impact related to the intention of the PR.
Linting Updates (!336) This update now runs Prettier before ESLint (with the Stylistic plugin) for code formatting. This takes care of a lot of the edge cases that ESLint doesn't touch by itself. Also adds the `eslint-plugin-unused-imports` ESLint plugin to remove unused imports and the `eslint-plugin-switch-allman` ESLint plugin to enforce Allman braces on case declarations. The VSCode format-on-save function now requires two additional extentions to be installed: Prettier and Format Code Action. Links can be found in the README and in the recommended extentions section of VSCode when the workspace is open. Co-authored-by: chomp <chomp@noreply.dev.sp-tarkov.com> Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/336 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-05-16 10:41:05 +02:00
- **Create a Meaningful Title**
Updates Server README (!306) - Updates the Server project README to include additional information about installation, development, and contribuation guidelines. - Moves the feature list to a dedicated FEATURE.md file (linked from the README.md). - Reviewed the FEATURES.md file to clean it up a little bit. Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/306 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-04-25 19:26:47 +02:00
When creating a PR, make sure the title is meaningful and describes the changes you've made.
Linting Updates (!336) This update now runs Prettier before ESLint (with the Stylistic plugin) for code formatting. This takes care of a lot of the edge cases that ESLint doesn't touch by itself. Also adds the `eslint-plugin-unused-imports` ESLint plugin to remove unused imports and the `eslint-plugin-switch-allman` ESLint plugin to enforce Allman braces on case declarations. The VSCode format-on-save function now requires two additional extentions to be installed: Prettier and Format Code Action. Links can be found in the README and in the recommended extentions section of VSCode when the workspace is open. Co-authored-by: chomp <chomp@noreply.dev.sp-tarkov.com> Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/336 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-05-16 10:41:05 +02:00
- **Write Detailed Commit Messages**
Updates Server README (!306) - Updates the Server project README to include additional information about installation, development, and contribuation guidelines. - Moves the feature list to a dedicated FEATURE.md file (linked from the README.md). - Reviewed the FEATURES.md file to clean it up a little bit. Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/306 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-04-25 19:26:47 +02:00
Bring out your table manners, speak the Queen's English and be on your best behaviour.
### Style Guide
Linting Updates (!336) This update now runs Prettier before ESLint (with the Stylistic plugin) for code formatting. This takes care of a lot of the edge cases that ESLint doesn't touch by itself. Also adds the `eslint-plugin-unused-imports` ESLint plugin to remove unused imports and the `eslint-plugin-switch-allman` ESLint plugin to enforce Allman braces on case declarations. The VSCode format-on-save function now requires two additional extentions to be installed: Prettier and Format Code Action. Links can be found in the README and in the recommended extentions section of VSCode when the workspace is open. Co-authored-by: chomp <chomp@noreply.dev.sp-tarkov.com> Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/336 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-05-16 10:41:05 +02:00
We use a combination of Prettier and ESLint Stylistic to enforce a consistent code style. Please run `npm run format` before submitting your changes. This is made easier by using the recommended VSC extensions to automatically format your code whenever you save a file.
Updates Server README (!306) - Updates the Server project README to include additional information about installation, development, and contribuation guidelines. - Moves the feature list to a dedicated FEATURE.md file (linked from the README.md). - Reviewed the FEATURES.md file to clean it up a little bit. Reviewed-on: https://dev.sp-tarkov.com/SPT-AKI/Server/pulls/306 Co-authored-by: Refringe <me@refringe.com> Co-committed-by: Refringe <me@refringe.com>
2024-04-25 19:26:47 +02:00
### Tests
We have a number of tests that are run automatically when you submit a pull request. You can run these tests locally by running `npm run test`. If you're adding a new feature or fixing a bug, please conceder adding tests to cover your changes so that we can ensure they don't break in the future.
## License
This project is licensed under the NCSA Open Source License. See the [LICENSE](LICENSE.md) file for details.
Reference in New Issue Copy Permalink