From c7ac3229f54e760eb40fc33f816d6d3185c08547 Mon Sep 17 00:00:00 2001 From: Oleksii Holub <1935960+Tyrrrz@users.noreply.github.com> Date: Wed, 1 Feb 2023 12:35:30 +0200 Subject: [PATCH] Hyphenate "command-line" --- .docs/Getting-started.md | 4 +- .github/ISSUE_TEMPLATE/bug-report.yml | 106 +++++++++++++------------- Changelog.md | 4 +- Readme.md | 4 +- 4 files changed, 59 insertions(+), 59 deletions(-) diff --git a/.docs/Getting-started.md b/.docs/Getting-started.md index 203e369..17bdeee 100644 --- a/.docs/Getting-started.md +++ b/.docs/Getting-started.md @@ -15,10 +15,10 @@ The information presented on this page is valid for **all** platforms. - **Graphical User Interface** (**GUI**) - it's the preferred version for newcomers as it is easy to use. You can get it by [downloading](https://github.com/Tyrrrz/DiscordChatExporter/releases/latest) the `DiscordChatExporter.zip` file. -- **Command Line Interface** (**CLI**) - offers greater flexibility and more features for advanced users, such as export scheduling, ID lists, and more specific date ranges. +- **Command-line Interface** (**CLI**) - offers greater flexibility and more features for advanced users, such as export scheduling, ID lists, and more specific date ranges. You can get it by [downloading](https://github.com/Tyrrrz/DiscordChatExporter/releases/latest) the `DiscordChatExporter.CLI.zip` file. -If you're not comfortable with **Windows'** Command Line (cmd), please choose the GUI. +If you're not comfortable with **Windows'** Command-line (cmd), please choose the GUI. [**macOS**](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/MacOS.md), [**Linux**](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Linux.md) and [**Docker**](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Docker.md) users can only use the CLI version. **(Skip to [Using the CLI](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#using-the-cli) or [File Formats](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Getting-started.md#file-formats))** diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index db3d8a3..3c09bda 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -3,62 +3,62 @@ description: Report broken functionality. labels: [bug] body: -- type: markdown - attributes: - value: | - 🧐 **Guidelines:** + - type: markdown + attributes: + value: | + 🧐 **Guidelines:** - - 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. + - 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 of DiscordChatExporter does this bug affect? - placeholder: ver X.Y.Z - validations: - required: true + - type: input + attributes: + label: Version + description: Which version of DiscordChatExporter does this bug affect? + placeholder: ver X.Y.Z + validations: + required: true -- type: dropdown - attributes: - label: Flavor - description: Does this bug affect the GUI version, the CLI version, or both? - multiple: true - options: - - GUI (Graphical User Interface) - - CLI (Command Line Interface) - validations: - required: true + - type: dropdown + attributes: + label: Flavor + description: Does this bug affect the GUI version, the CLI version, or both? + multiple: true + options: + - GUI (Graphical User Interface) + - CLI (Command-Line Interface) + validations: + required: true -- type: dropdown - attributes: - label: Export format - description: Does this bug affect specific export format(s)? If not applicable, leave this field blank. - multiple: true - options: - - HTML - - TXT - - JSON - - CSV + - type: dropdown + attributes: + label: Export format + description: Does this bug affect specific export format(s)? If not applicable, leave this field blank. + multiple: true + options: + - HTML + - TXT + - JSON + - CSV -- type: textarea - attributes: - label: Details - description: Clear and thorough explanation of the bug. - placeholder: I was doing X expecting Y to happen, but Z happened instead. - validations: - required: true + - type: textarea + attributes: + label: Details + description: Clear and thorough explanation of the bug. + placeholder: I was doing X expecting Y to happen, but Z happened instead. + validations: + required: true -- type: textarea - 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 + - type: textarea + attributes: + label: Steps to reproduce + description: Minimum steps required to reproduce the bug. + placeholder: | + - Step 1 + - Step 2 + - Step 3 + validations: + required: true diff --git a/Changelog.md b/Changelog.md index 61224f4..6340779 100644 --- a/Changelog.md +++ b/Changelog.md @@ -467,7 +467,7 @@ Please note that CSV export is most likely not going to receive future updates a ### v2.4 (08-Apr-2018) - Added channel topic to output. -- Added a command line interface alternative to the current graphical user interface. +- Added a command-line interface alternative to the current graphical user interface. - Implemented application auto-update (can be disabled in settings). - Improved some GUI elements and replaced some dialogs with notifications. - Fixed a lot of issues with the markdown processor. @@ -481,4 +481,4 @@ Please note that CSV export is most likely not going to receive future updates a - Added support for user and role mentions. - Added support for channel mentions. - Fixed text in pre blocks not being wrapped correctly. -- Added workaround for non-default message types. \ No newline at end of file +- Added workaround for non-default message types. diff --git a/Readme.md b/Readme.md index aa144b9..40b1431 100644 --- a/Readme.md +++ b/Readme.md @@ -31,7 +31,7 @@ To learn more about the war and how you can help, [click here](https://tyrrrz.me ## Download -This application comes in two flavors: graphical user interface (**GUI**) and command line interface (**CLI**). +This application comes in two flavors: graphical user interface (**GUI**) and command-line interface (**CLI**). The following table lists all available download options: @@ -97,7 +97,7 @@ The following table lists all available download options: ## Features - Graphical user interface (Windows) -- Command line interface (Windows, Linux, macOS) +- Command-line interface (Windows, Linux, macOS) - Authentication via both user and bot tokens - Multiple output formats: HTML (dark/light), TXT, CSV, JSON - Support for markdown, attachments, embeds, emoji, and other rich media features