diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 5df48c3..0eaf4ac 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,27 +1,30 @@ -name: "\U0001F41E Bug report" +name: 🐞 Bug report description: Report broken functionality. labels: [bug] + body: - type: markdown attributes: value: | - Important: + 🧐 **Guidelines:** - - Please check existing issues (both opened and closed) to ensure that this bug hasn't 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. + - Search through [existing issues](https://github.com/Tyrrrz/DiscordChatExporter/issues?q=is%3Aissue) first to ensure that this bug has not been reported before. + - 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. - type: input attributes: label: Version - description: "Which version(s) of DiscordChatExporter does this bug affect?" + description: "Which version of DiscordChatExporter does this bug affect?" validations: required: true - type: dropdown attributes: 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 options: - GUI (Graphical User Interface) @@ -32,7 +35,7 @@ body: - type: dropdown attributes: 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 options: - HTML @@ -43,7 +46,7 @@ body: - type: textarea attributes: 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: required: true @@ -51,5 +54,9 @@ body: attributes: label: Steps to reproduce description: "Minimum steps required to reproduce the bug." + placeholder: | + - Step 1 + - Step 2 + - Step 3 validations: required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index c47f7a3..b2bc26c 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,8 @@ blank_issues_enabled: false contact_links: - - name: "\U0001F4D6 Read the wiki" + - name: 📖 Wiki url: https://github.com/Tyrrrz/DiscordChatExporter/wiki - about: Find answers to most common questions. - - name: "\U0001F5E8 Ask a question" + about: Find usage guides and frequently asked questions. + - name: 🗨 Discussions url: https://github.com/Tyrrrz/DiscordChatExporter/discussions/new - about: Please ask and answer questions here. \ No newline at end of file + about: Ask and answer questions. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 8e9667f..d4cf341 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -1,20 +1,23 @@ -name: "\U00002728 Feature request" +name: ✨ Feature request description: Request a new feature. labels: [enhancement] + body: - type: markdown attributes: value: | - Important: + 🧐 **Guidelines:** - - Please check existing issues (both opened and closed) to ensure that this feature hasn't 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. + - Search through [existing issues](https://github.com/Tyrrrz/DiscordChatExporter/issues?q=is%3Aissue) first to ensure that this feature has not been requested before. + - 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. - type: dropdown attributes: 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 options: - GUI (Graphical User Interface) @@ -23,7 +26,7 @@ body: - type: dropdown attributes: 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 options: - HTML @@ -34,6 +37,6 @@ body: - type: textarea attributes: 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: required: true \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..d8cd1fb --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,17 @@ + + + +Closes #ISSUE_NUMBER \ No newline at end of file diff --git a/Contributing.md b/Contributing.md deleted file mode 100644 index 528ef41..0000000 --- a/Contributing.md +++ /dev/null @@ -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 -``` diff --git a/Readme.md b/Readme.md index 1858c6a..603603b 100644 --- a/Readme.md +++ b/Readme.md @@ -61,12 +61,12 @@ The following table lists all available download options: -- 🦄 - Community-maintained resource - ⚙️ - 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 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 **Linux**](https://docs.microsoft.com/en-us/dotnet/core/install/linux) (find your distro) +- 🦄 - Community-maintained resource ## Features @@ -82,4 +82,33 @@ The following table lists all available download options: ## Screenshots ![channel list](.screenshots/list.png) -![rendered output](.screenshots/output.png) \ No newline at end of file +![rendered output](.screenshots/output.png) + +## 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 +``` \ No newline at end of file