Merge branch 'develop' into dotnet-format
This commit is contained in:
Refringe
GitHub
@@ -0,0 +1,101 @@
|
||||
name: "Bug Report"
|
||||
description: "Report a bug in the SPT project."
|
||||
labels: ["triage"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
## Thank you for taking the time to fill out a bug report!
|
||||
|
||||
Please note the following requirements:
|
||||
|
||||
- You must be able to replicate the issue with a fresh profile, running no mods. If you can't, we can't fix it.
|
||||
- If you are using a profile from an older version, please make a fresh profile and replicate the issue before submitting.
|
||||
- You must upload all the required log files, even if you think they are useless.
|
||||
- Failure to comply with any of the above requirements will result in your issue being closed without notice.
|
||||
- type: dropdown
|
||||
id: version
|
||||
attributes:
|
||||
label: SPT Version
|
||||
description: What version of SPT are you using?
|
||||
options:
|
||||
- "4.0"
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: projects
|
||||
attributes:
|
||||
label: "Project Type"
|
||||
description: "If known, which part of the project is involved in this bug report?"
|
||||
options:
|
||||
- "Server"
|
||||
- "Modules"
|
||||
- "Launcher"
|
||||
multiple: true
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
id: result_expected
|
||||
attributes:
|
||||
label: "Expected Result"
|
||||
description: "What you expect to happen?"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: result_actual
|
||||
attributes:
|
||||
label: "Actual Result"
|
||||
description: "What actually happened?"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: reproduce
|
||||
attributes:
|
||||
label: "Steps To Reproduce"
|
||||
description: "Describe in point form the steps we can take to reproduce the issue on our end."
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: log_server
|
||||
attributes:
|
||||
label: "Server Log"
|
||||
description: "Upload a copy of your *entire* server log: `/user/logs/spt/spt.txt`."
|
||||
placeholder: "Attach the log file. Do not paste the contents."
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: log_bepinex
|
||||
attributes:
|
||||
label: "BepinEx Log"
|
||||
description: "Upload a copy of your *entire* BepinEx log: `/BepinEx/LogOutput.log`."
|
||||
placeholder: "Attach the log file. Do not paste the contents."
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: log_client
|
||||
attributes:
|
||||
label: "Client Log"
|
||||
description: "Upload a copy of your *entire* client log: `/Logs/log_<date>_<version>/<date>_<version> traces.log`."
|
||||
placeholder: "Attach the log file. Do not paste the contents."
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: profile
|
||||
attributes:
|
||||
label: "Player Profile"
|
||||
description: "If helpful, upload a copy of your *entire* player profile: `/user/profiles/<profileId>.json`."
|
||||
placeholder: "Attach the profile file. Do not paste the contents."
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
id: screenshots
|
||||
attributes:
|
||||
label: "Screenshots"
|
||||
description: "If helpful, upload any screenshots or videos you think would help us identify the issue."
|
||||
validations:
|
||||
required: false
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
## BEFORE YOU SUBMIT
|
||||
Ensure that your logs are attached. **No logs = Issue deleted**
|
||||
@@ -0,0 +1,8 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Discord Community
|
||||
url: https://discord.com/invite/Xn9msqQZan
|
||||
about: Find community support through our Discord server.
|
||||
- name: Github Discussions
|
||||
url: https://github.com/orgs/sp-tarkov/discussions
|
||||
about: Please duscuss the project on the Github Discussions board.
|
||||
@@ -1,90 +0,0 @@
|
||||
# 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)
|
||||
- [Requirements](#requirements)
|
||||
- [Initial Setup](#initial-setup)
|
||||
- [Development](#development)
|
||||
- [Commands](#commands)
|
||||
- [Debugging](#debugging)
|
||||
- [Mod Debugging](#mod-debugging)
|
||||
- [Contributing](#contributing)
|
||||
- [Branches](#branchs)
|
||||
- [Pull Request Guidelines](#pull-request-guidelines)
|
||||
- [Tests](#tests)
|
||||
- [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](https://visualstudio.microsoft.com/) (VS) and [Rider](https://www.jetbrains.com/rider/) using [.NET](https://dotnet.microsoft.com/en-us/)
|
||||
|
||||
### Initial Setup
|
||||
|
||||
To prepare the project for development you will need to:
|
||||
|
||||
1. Run `git clone https://github.com/sp-tarkov/server-csharp.git server` to clone the repository
|
||||
2. Run `git lfs pull` to download LFS files locally.
|
||||
3. Open the `project/server-csharp.sln` file in Visual Studio or Rider
|
||||
4. Run `Build > Build Solution (CTRL + SHIFT + B)` in the IDE
|
||||
|
||||
## Development
|
||||
|
||||
### Commands
|
||||
|
||||
### Debugging
|
||||
|
||||
To debug the project in Visual Studio Code:
|
||||
1. Choose `Server` and `Spt Server Debug` in the debug dropdowns
|
||||
2. Choose `Debug > Start Debugging (F5)` to run the server
|
||||
|
||||
### Mod Debugging
|
||||
|
||||
To debug a server mod in Visual Studio, you can copy the mod DLL into the `user/mods` folder and then start the server
|
||||
|
||||
## Contributing
|
||||
|
||||
We're really excited that you're interested in contributing! Before submitting your contribution, please consider the following:
|
||||
|
||||
### Branches
|
||||
|
||||
- **master**
|
||||
The default branch used for the latest stable release. This branch is protected and typically is only merged with release branches.
|
||||
- **development**
|
||||
The main branch for server development. PRs should target this.
|
||||
|
||||
### Pull Request Guidelines
|
||||
|
||||
- **Keep Them Small**
|
||||
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.
|
||||
- **Perform a Self-Review**
|
||||
Before submitting your changes, review your own code. This will help you catch any mistakes you may have made.
|
||||
- **Remove Noise**
|
||||
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.
|
||||
- **Create a Meaningful Title**
|
||||
When creating a PR, make sure the title is meaningful and describes the changes you've made.
|
||||
- **Write Detailed Commit Messages**
|
||||
Bring out your table manners, speak the Queen's English and be on your best behaviour.
|
||||
|
||||
### Style Guide
|
||||
|
||||
TODO: style guidance
|
||||
Ensure that your code is automatically formatted whenever you save a file.
|
||||
|
||||
### 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 The unit test sub-project. 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
Block a user