diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index d51d6b9a..496d1a88 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,16 +1,12 @@ ---- -name: 🐛 Bug Report -about: Create a report to help improve the project -title: \U0001F41B -labels: 🐛 bug -assignees: kdeldycke ---- +______________________________________________________________________ + +## name: 🐛 Bug Report about: Create a report to help improve the project title: \\U0001F41B labels: 🐛 bug assignees: kdeldycke #### Preliminary checks -- [ ] I am running the latest version -- [ ] I have [read the Code of Conduct](https://github.com/kdeldycke/mail-deduplicate/blob/main/.github/code-of-conduct.md) -- [ ] I have checked there is not other [Issues](https://github.com/kdeldycke/mail-deduplicate/issues) or [Pull Requests](https://github.com/kdeldycke/mail-deduplicate/pulls) covering the same topic to open +- \[ \] I am running the latest version +- \[ \] I have [read the Code of Conduct](https://github.com/kdeldycke/mail-deduplicate/blob/main/.github/code-of-conduct.md) +- \[ \] I have checked there is not other [Issues](https://github.com/kdeldycke/mail-deduplicate/issues) or [Pull Requests](https://github.com/kdeldycke/mail-deduplicate/pulls) covering the same topic to open #### Describe the bug diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 3632a13f..80b507fc 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,12 +1,15 @@ ---- +______________________________________________________________________ + name: 🎁 Feature request about: Suggest an idea for this project title: 🎁 labels: - - 🎁 feature request - - 🙏 help wanted -assignees: kdeldycke ---- + +- 🎁 feature request +- 🙏 help wanted + assignees: kdeldycke + +______________________________________________________________________ **Is your feature request related to a problem? Please describe.** A clear and concise description of what the problem is. Ex. I'm always frustrated when \[...\] diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 1e9c36ce..56cb3277 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -4,27 +4,27 @@ This PR fixes/implements the following bugs/features: -- [ ] Bug 1 -- [ ] Bug 2 -- [ ] Feature 1 -- [ ] Feature 2 -- [ ] Breaking changes +- \[ \] Bug 1 +- \[ \] Bug 2 +- \[ \] Feature 1 +- \[ \] Feature 2 +- \[ \] Breaking changes Explain the motivation for making this change. What existing problem does the pull request solve? #### Preliminary checks -- [ ] I have [read the Code of Conduct](https://github.com/kdeldycke/mail-deduplicate/blob/main/.github/code-of-conduct.md) -- [ ] I have referenced above all [issues](https://github.com/kdeldycke/mail-deduplicate/issues) related to the changes I'm bringing -- [ ] I have checked there is no other [Pull Requests](https://github.com/kdeldycke/mail-deduplicate/pulls) covering the same thing I'm about to address +- \[ \] I have [read the Code of Conduct](https://github.com/kdeldycke/mail-deduplicate/blob/main/.github/code-of-conduct.md) +- \[ \] I have referenced above all [issues](https://github.com/kdeldycke/mail-deduplicate/issues) related to the changes I'm bringing +- \[ \] I have checked there is no other [Pull Requests](https://github.com/kdeldycke/mail-deduplicate/pulls) covering the same thing I'm about to address #### New Features Submissions: -1. [ ] Does your submission pass tests? -1. [ ] Have you lint your code locally prior to submission? +1. \[ \] Does your submission pass tests? +1. \[ \] Have you lint your code locally prior to submission? #### Changes to Core Features: -- [ ] Have you added an explanation of what your changes do and why you'd like us to include them? -- [ ] Have you written new tests for your core changes, as applicable? -- [ ] Have you successfully ran tests with your changes locally? +- \[ \] Have you added an explanation of what your changes do and why you'd like us to include them? +- \[ \] Have you written new tests for your core changes, as applicable? +- \[ \] Have you successfully ran tests with your changes locally? diff --git a/docs/index.md b/docs/index.md index a29bf333..247d899d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ ---- -hide-toc: true ---- +______________________________________________________________________ + +## hide-toc: true ```{include} ../readme.md ``` diff --git a/readme.md b/readme.md index 4516c8bb..2ba7b92c 100644 --- a/readme.md +++ b/readme.md @@ -71,4 +71,4 @@ Standalone executables of `mdedup`'s latest version are available for several pl | ----------- | ---------------------------------------------------------------------------------------------------------------------------------- |-------------------------------------------------------------------------------------------------------------------------------- | | **Linux** | [Download `mdedup-linux-x64.bin`](https://github.com/kdeldycke/mail-deduplicate/releases/latest/download/mdedup-linux-x64.bin) | | | **macOS** | [Download `mdedup-macos-x64.bin`](https://github.com/kdeldycke/mail-deduplicate/releases/latest/download/mdedup-macos-x64.bin) | [Download `mdedup-macos-arm64.bin`](https://github.com/kdeldycke/mail-deduplicate/releases/latest/download/mdedup-macos-arm64.bin) | -| **Windows** | [Download `mdedup-windows-x64.exe`](https://github.com/kdeldycke/mail-deduplicate/releases/latest/download/mdedup-windows-x64.exe) | | \ No newline at end of file +| **Windows** | [Download `mdedup-windows-x64.exe`](https://github.com/kdeldycke/mail-deduplicate/releases/latest/download/mdedup-windows-x64.exe) | |