Update CONTRIBUTING.md

This commit is contained in:
ilike2burnthing 2023-03-05 21:28:12 +00:00 committed by GitHub
parent bbeca179d9
commit 0c10704eae
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 14 deletions

View File

@ -33,19 +33,13 @@ Before you submit a bug-report or do any other troubleshooting, make sure your J
We are releasing bug fixes almost daily, so your issue may have been fixed already. We are releasing bug fixes almost daily, so your issue may have been fixed already.
Bugs that are submitted without being on the latest version may be closed. Bugs that are submitted without being on the latest version may be closed.
**Error "An error occurred while sending the request: Error: TrustFailure (A call to SSPI failed, see inner exception.)"**
This is often caused by missing CA certificates.
Try reimporting the certificates in this case:
- On Linux (as user root): `wget -O - https://curl.haxx.se/ca/cacert.pem | cert-sync /dev/stdin`
- On macOS: `curl -sS https://curl.haxx.se/ca/cacert.pem | cert-sync --user /dev/stdin`
**Tracker isn't working** **Tracker isn't working**
If you are experiencing an issue with a tracker, then: If you are experiencing an issue with a tracker, then:
- Use your browser to check you can access the site directly, and if a login is required, - Use your browser to check you can access the site directly, and if a login is required,
check you can login and that you do not have any outstanding account issues. check you can login and that you do not have any outstanding account issues.
- If you haven't already, try upgrading to the latest version of Jackett. - If you haven't already, try upgrading to the latest version of Jackett.
- Check our [Troubleshooting wiki](https://github.com/Jackett/Jackett/wiki/Troubleshooting) for common issues.
- If it is still not working for you, then a **full enhanced log must be included**. - If it is still not working for you, then a **full enhanced log must be included**.
**Enable enhanced logging** **Enable enhanced logging**
@ -68,9 +62,9 @@ Your issue should have the following information.
- **Descriptive Title** - The title of your bug should include keywords and a descriptive summary of what you're experiencing - **Descriptive Title** - The title of your bug should include keywords and a descriptive summary of what you're experiencing
to help others avoid duplicating your bug report to help others avoid duplicating your bug report
- Keywords in the title should be as follows: - Keywords in the title should be as follows:
- Tracker bugs should start with the tracker in brackets e.g. [**AnimeBytes**] - Indexer bugs should start with the indexer ID in brackets e.g. **[thepiratebay]**
- Feature requests should start with [**REQ**] - Feature requests should start with **[req]**
- New trackers should begin with [**New**] and the tracker type [**Public**/**Private**/**Semi-Private**] e.g. **[New][Public] ThePirateBay** - Indexers requests should start with **[req]** and the name of the tracker e.g. **[req] ThePirateBay**
- **Environment Details** - These are things like your OS version, Jackett type and version, mono/.Net-core/framework version(s). - **Environment Details** - These are things like your OS version, Jackett type and version, mono/.Net-core/framework version(s).
These are asked for by the issue template when you create a new issue on GitHub. These are asked for by the issue template when you create a new issue on GitHub.
- **Steps** to cause the problem, if applicable. These should be specific and repeatable. - **Steps** to cause the problem, if applicable. These should be specific and repeatable.
@ -112,15 +106,15 @@ If you use something else, please add it here for others.
<details open=true> <summary> Visual Studio 2022 </summary> <details open=true> <summary> Visual Studio 2022 </summary>
- Install [Visual Studio Community 2022](https://visualstudio.microsoft.com/vs/) for free. - Install [Visual Studio Community 2022](https://visualstudio.microsoft.com/vs/) for free.
- About 2GB download. 8GB installed. - About 2GB download, 8GB installed.
- Make sure it includes the following Workload and Individual Components: - Make sure it includes the following Workload and Individual Components:
- .NET desktop development - .NET desktop development
- .Net Framework 4.6.1 SDK - .Net Framework 4.6.2 SDK
- .Net Framework 4.6.1 targeting pack - .Net Framework 4.6.2 targeting pack
- From the `Get Started` screen: - From the `Get Started` screen:
- `Clone a repository -> Browse a repository -> GitHub -> Sign in -> clone your forked repository` - `Clone a repository -> Browse a repository -> GitHub -> Sign in -> clone your forked repository`
- Double-click `Jackett.sln` in `Solution Explorer` to load your project - Double-click `Jackett.sln` in `Solution Explorer` to load your project
- Ensure `Jackett.Server` is the Startup Project (instead of `Jackett.Service`) and the Run Target (instead of `IIS Express`) - Ensure `Jackett.Server` is the Startup Project and the Run Target (instead of `Jackett.Service`)
- Open `Tools -> NuGet Package Manager -> Package Manager Console` - Open `Tools -> NuGet Package Manager -> Package Manager Console`
- From the PMC, with `Jackett.Service` as the default project, run: - From the PMC, with `Jackett.Service` as the default project, run:
- `dotnet tool install -g dotnet-format` - `dotnet tool install -g dotnet-format`