mirror of
https://github.com/Tyrrrz/DiscordChatExporter.git
synced 2025-05-22 10:55:15 -04:00
Refactor issue forms and add pull request template
This commit is contained in:
parent
5b5a53dbf4
commit
79a9ac0462
6 changed files with 77 additions and 77 deletions
23
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
23
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
|
@ -1,27 +1,30 @@
|
||||||
name: "\U0001F41E Bug report"
|
name: 🐞 Bug report
|
||||||
description: Report broken functionality.
|
description: Report broken functionality.
|
||||||
labels: [bug]
|
labels: [bug]
|
||||||
|
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
Important:
|
🧐 **Guidelines:**
|
||||||
|
|
||||||
- Please check existing issues (both opened and closed) to ensure that this bug hasn't been reported before.
|
- Search through [existing issues](https://github.com/Tyrrrz/DiscordChatExporter/issues?q=is%3Aissue) first to ensure that this bug has not been reported before.
|
||||||
- Refer to the [contribution guidelines](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/Contributing.md) for info on how to file a good issue.
|
- Write a descriptive title for your issue. Avoid generic or vague titles such as "Something's not working" or "A couple of problems".
|
||||||
|
- Keep your issue focused on one single problem. If you have multiple bug reports, please create separate issues for each of them.
|
||||||
|
- Provide as much context as possible in the details section. Include screenshots, screen recordings, links, references, or anything else you may consider relevant.
|
||||||
- If you want to ask a question instead of reporting a bug, please use [discussions](https://github.com/Tyrrrz/DiscordChatExporter/discussions/new) instead.
|
- If you want to ask a question instead of reporting a bug, please use [discussions](https://github.com/Tyrrrz/DiscordChatExporter/discussions/new) instead.
|
||||||
|
|
||||||
- type: input
|
- type: input
|
||||||
attributes:
|
attributes:
|
||||||
label: Version
|
label: Version
|
||||||
description: "Which version(s) of DiscordChatExporter does this bug affect?"
|
description: "Which version of DiscordChatExporter does this bug affect?"
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: dropdown
|
- type: dropdown
|
||||||
attributes:
|
attributes:
|
||||||
label: Flavor
|
label: Flavor
|
||||||
description: "Which flavor(s) of DiscordChatExporter does this bug affect?"
|
description: "Does this bug affect the GUI version, the CLI version, or both?"
|
||||||
multiple: true
|
multiple: true
|
||||||
options:
|
options:
|
||||||
- GUI (Graphical User Interface)
|
- GUI (Graphical User Interface)
|
||||||
|
@ -32,7 +35,7 @@ body:
|
||||||
- type: dropdown
|
- type: dropdown
|
||||||
attributes:
|
attributes:
|
||||||
label: Export format
|
label: Export format
|
||||||
description: "Which export format(s) does this bug affect? If this bug is not related to any specific export format, leave this blank."
|
description: "Does this bug affect specific export format(s)? If not applicable, leave this field blank."
|
||||||
multiple: true
|
multiple: true
|
||||||
options:
|
options:
|
||||||
- HTML
|
- HTML
|
||||||
|
@ -43,7 +46,7 @@ body:
|
||||||
- type: textarea
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
label: Details
|
label: Details
|
||||||
description: "Clear and thorough explanation of the bug. If relevant, include screenshots or screen recordings."
|
description: "Clear and thorough explanation of the bug."
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
|
@ -51,5 +54,9 @@ body:
|
||||||
attributes:
|
attributes:
|
||||||
label: Steps to reproduce
|
label: Steps to reproduce
|
||||||
description: "Minimum steps required to reproduce the bug."
|
description: "Minimum steps required to reproduce the bug."
|
||||||
|
placeholder: |
|
||||||
|
- Step 1
|
||||||
|
- Step 2
|
||||||
|
- Step 3
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
8
.github/ISSUE_TEMPLATE/config.yml
vendored
8
.github/ISSUE_TEMPLATE/config.yml
vendored
|
@ -1,8 +1,8 @@
|
||||||
blank_issues_enabled: false
|
blank_issues_enabled: false
|
||||||
contact_links:
|
contact_links:
|
||||||
- name: "\U0001F4D6 Read the wiki"
|
- name: 📖 Wiki
|
||||||
url: https://github.com/Tyrrrz/DiscordChatExporter/wiki
|
url: https://github.com/Tyrrrz/DiscordChatExporter/wiki
|
||||||
about: Find answers to most common questions.
|
about: Find usage guides and frequently asked questions.
|
||||||
- name: "\U0001F5E8 Ask a question"
|
- name: 🗨 Discussions
|
||||||
url: https://github.com/Tyrrrz/DiscordChatExporter/discussions/new
|
url: https://github.com/Tyrrrz/DiscordChatExporter/discussions/new
|
||||||
about: Please ask and answer questions here.
|
about: Ask and answer questions.
|
17
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
17
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
|
@ -1,20 +1,23 @@
|
||||||
name: "\U00002728 Feature request"
|
name: ✨ Feature request
|
||||||
description: Request a new feature.
|
description: Request a new feature.
|
||||||
labels: [enhancement]
|
labels: [enhancement]
|
||||||
|
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
Important:
|
🧐 **Guidelines:**
|
||||||
|
|
||||||
- Please check existing issues (both opened and closed) to ensure that this feature hasn't been requested before.
|
- Search through [existing issues](https://github.com/Tyrrrz/DiscordChatExporter/issues?q=is%3Aissue) first to ensure that this feature has not been requested before.
|
||||||
- Refer to the [contribution guidelines](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/Contributing.md) for info on how to file a good issue.
|
- Write a descriptive title for your issue. Avoid generic or vague titles such as "Some suggestions" or "Ideas for improvement".
|
||||||
|
- Keep your issue focused on one single problem. If you have multiple feature requests, please create separate issues for each of them.
|
||||||
|
- Provide as much context as possible in the details section. Include screenshots, screen recordings, links, references, or anything else you may consider relevant.
|
||||||
- If you want to ask a question instead of requesting a feature, please use [discussions](https://github.com/Tyrrrz/DiscordChatExporter/discussions/new) instead.
|
- If you want to ask a question instead of requesting a feature, please use [discussions](https://github.com/Tyrrrz/DiscordChatExporter/discussions/new) instead.
|
||||||
|
|
||||||
- type: dropdown
|
- type: dropdown
|
||||||
attributes:
|
attributes:
|
||||||
label: Flavor
|
label: Flavor
|
||||||
description: "Which flavor(s) of DiscordChatExporter does this feature request apply to? If this feature is not related to any specific flavor, leave this blank."
|
description: "Is this feature request related to specific flavor(s) of DiscordChatExporter? If not applicable, leave this field blank."
|
||||||
multiple: true
|
multiple: true
|
||||||
options:
|
options:
|
||||||
- GUI (Graphical User Interface)
|
- GUI (Graphical User Interface)
|
||||||
|
@ -23,7 +26,7 @@ body:
|
||||||
- type: dropdown
|
- type: dropdown
|
||||||
attributes:
|
attributes:
|
||||||
label: Export format
|
label: Export format
|
||||||
description: "Which export format(s) does this feature request apply to? If this feature is not related to any specific export format, leave this blank."
|
description: "Is this feature request related to specific export format(s)? If not applicable, leave this field blank."
|
||||||
multiple: true
|
multiple: true
|
||||||
options:
|
options:
|
||||||
- HTML
|
- HTML
|
||||||
|
@ -34,6 +37,6 @@ body:
|
||||||
- type: textarea
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
label: Details
|
label: Details
|
||||||
description: "Clear and thorough explanation of the feature you have in mind. If relevant, include screenshots or screen recordings."
|
description: "Clear and thorough explanation of the feature you have in mind."
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
17
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
17
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
@ -0,0 +1,17 @@
|
||||||
|
<!--
|
||||||
|
|
||||||
|
**Important:**
|
||||||
|
|
||||||
|
Please make sure that there is an existing issue that describes the problem solved by your pull request. If there isn't one, consider creating it first.
|
||||||
|
An open issue offers a good place to iron out requirements, discuss possible solutions, and ask questions.
|
||||||
|
|
||||||
|
Remember to also:
|
||||||
|
|
||||||
|
- Keep your pull request focused and as small as possible. If you want to contribute multiple unrelated changes, please create separate pull requests for them.
|
||||||
|
- Follow the coding style and conventions already established by the project. When in doubt about which style to use, ask in the comments to your pull request.
|
||||||
|
- If you want to start a discussion regarding a specific change you've made, add a review comment to your own code. This can be used to highlight something important or to seek further input from others.
|
||||||
|
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!-- Please specify the issue addressed by this pull request -->
|
||||||
|
Closes #ISSUE_NUMBER
|
|
@ -1,56 +0,0 @@
|
||||||
# Contributing
|
|
||||||
|
|
||||||
DiscordChatExporter accepts contributions in the form of issues and pull requests.
|
|
||||||
|
|
||||||
## Creating issues
|
|
||||||
|
|
||||||
If you have a feature suggestion or want to report a bug, you are welcome to create an issue.
|
|
||||||
|
|
||||||
Guidelines:
|
|
||||||
|
|
||||||
- Avoid creating an issue if a similar one already exists. Look through existing open and closed issues first.
|
|
||||||
- Keep your issue focused on one specific problem. If you have multiple suggestions or bug reports, please create separate issues for them.
|
|
||||||
- Provide a descriptive title for your issue. Don't use generic titles like "A couple suggestions" or "Not working".
|
|
||||||
- Provide more context in the body of the issue. If relevant, attach screenshots or screen recordings.
|
|
||||||
- Remain civil and respectful when participating in discussions.
|
|
||||||
|
|
||||||
## Creating pull requests
|
|
||||||
|
|
||||||
If you want to contribute code to the project, you can do so by creating a pull request.
|
|
||||||
|
|
||||||
Guidelines:
|
|
||||||
|
|
||||||
- Make sure that there is an existing issue that describes the problem solved by your pull request. If there isn't one, please create it first.
|
|
||||||
- Add a comment to the issue indicating that you want to submit a pull request for it. This can be a good opportunity to discuss possible solutions, finalize requirements, or ask questions.
|
|
||||||
- Keep your pull request focused and as small as possible. If you want to contribute multiple unrelated changes, please create separate pull requests for them.
|
|
||||||
- Follow the coding style and conventions already established by the project. When in doubt which style to use, ask in comments to your pull request.
|
|
||||||
- If you want to start a discussion regarding a specific change you made, add a review comment to your own code. This can be used to highlight something important or to seek input from others.
|
|
||||||
|
|
||||||
## Building the project locally
|
|
||||||
|
|
||||||
Prerequisites:
|
|
||||||
|
|
||||||
- [.NET 5.0 SDK](https://dotnet.microsoft.com/download/dotnet/5.0)
|
|
||||||
- [.NET 3.1 SDK](https://dotnet.microsoft.com/download/dotnet/3.1) (temporarily as the app still targets .NET 3.1, but requires .NET 5.0 to build)
|
|
||||||
- _(Optional)_ C#/.NET IDE, such as [JetBrains Rider](https://www.jetbrains.com/rider), [VS Code](https://code.visualstudio.com/docs/languages/csharp), or [Visual Studio](https://visualstudio.microsoft.com).
|
|
||||||
|
|
||||||
To build the entire solution run the following command in the root of the repository:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
> dotnet build
|
|
||||||
```
|
|
||||||
|
|
||||||
This will generate runtime artifacts for each project:
|
|
||||||
|
|
||||||
```plaintext
|
|
||||||
./DiscordChatExporter.Gui/bin/[Debug|Release]/[runtime]/*
|
|
||||||
./DiscordChatExporter.Cli/bin/[Debug|Release]/[runtime]/*
|
|
||||||
```
|
|
||||||
|
|
||||||
You can also build and run a specific project directly.
|
|
||||||
To do that, navigate to its directory and use `dotnet run`:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
> cd DiscordChatExporter.Gui
|
|
||||||
> dotnet run
|
|
||||||
```
|
|
31
Readme.md
31
Readme.md
|
@ -61,12 +61,12 @@ The following table lists all available download options:
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
- 🦄 - Community-maintained resource
|
|
||||||
- ⚙️ - Requires .NET runtime to be installed manually:
|
- ⚙️ - Requires .NET runtime to be installed manually:
|
||||||
- [.NET Core v3.1 Runtime for **Windows x64**](https://dotnet.microsoft.com/download/dotnet-core/thank-you/runtime-desktop-3.1.0-windows-x64-installer)
|
- [.NET Core v3.1 Runtime for **Windows x64**](https://dotnet.microsoft.com/download/dotnet-core/thank-you/runtime-desktop-3.1.0-windows-x64-installer)
|
||||||
- [.NET Core v3.1 Runtime for **Windows x86**](https://dotnet.microsoft.com/download/dotnet-core/thank-you/runtime-desktop-3.1.0-windows-x86-installer)
|
- [.NET Core v3.1 Runtime for **Windows x86**](https://dotnet.microsoft.com/download/dotnet-core/thank-you/runtime-desktop-3.1.0-windows-x86-installer)
|
||||||
- [.NET Core v3.1 Runtime for **macOS x64**](https://dotnet.microsoft.com/download/dotnet-core/thank-you/runtime-3.1.0-macos-x64-installer)
|
- [.NET Core v3.1 Runtime for **macOS x64**](https://dotnet.microsoft.com/download/dotnet-core/thank-you/runtime-3.1.0-macos-x64-installer)
|
||||||
- [.NET Core v3.1 Runtime for **Linux**](https://docs.microsoft.com/en-us/dotnet/core/install/linux) (find your distro)
|
- [.NET Core v3.1 Runtime for **Linux**](https://docs.microsoft.com/en-us/dotnet/core/install/linux) (find your distro)
|
||||||
|
- 🦄 - Community-maintained resource
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
|
@ -83,3 +83,32 @@ The following table lists all available download options:
|
||||||
|
|
||||||

|

|
||||||

|

|
||||||
|
|
||||||
|
## Building the project locally
|
||||||
|
|
||||||
|
Prerequisites:
|
||||||
|
|
||||||
|
- [.NET 5.0 SDK](https://dotnet.microsoft.com/download/dotnet/5.0)
|
||||||
|
- [.NET 3.1 SDK](https://dotnet.microsoft.com/download/dotnet/3.1) (temporarily as the app still targets .NET 3.1, but requires .NET 5.0 to build)
|
||||||
|
- _(Recommended)_ C#/.NET IDE, such as [JetBrains Rider](https://www.jetbrains.com/rider), [VS Code](https://code.visualstudio.com/docs/languages/csharp), or [Visual Studio](https://visualstudio.microsoft.com).
|
||||||
|
|
||||||
|
To build the entire solution run the following command in the root of the repository:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
> dotnet build
|
||||||
|
```
|
||||||
|
|
||||||
|
This will generate runtime artifacts for each project:
|
||||||
|
|
||||||
|
```plaintext
|
||||||
|
./DiscordChatExporter.Gui/bin/[Debug|Release]/[runtime]/*
|
||||||
|
./DiscordChatExporter.Cli/bin/[Debug|Release]/[runtime]/*
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also build and run a specific project directly.
|
||||||
|
To do that, navigate to its directory and use `dotnet run`:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
> cd DiscordChatExporter.Gui
|
||||||
|
> dotnet run
|
||||||
|
```
|
Loading…
Add table
Add a link
Reference in a new issue