From 0df0e9d366c350bc9b046fd1422b62abf6737d8a Mon Sep 17 00:00:00 2001 From: DA344 <108473820+DA-344@users.noreply.github.com> Date: Wed, 7 Aug 2024 01:12:22 +0200 Subject: [PATCH 01/14] create pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..dd95126 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,22 @@ +## Brief Description + + + +## Detailed Description + + + +## Change Log + + + + +## Checklist + + + +- [ ] PR contents come from a trusted source, such as DDeva Docs PR, [unofficial documentation](https://docs.discord.sex/), Discord staff mention, or others. +- [ ] Changed files formatting works as expected. From 703a1b2dcc058b9fc68f7809954da72b33f76870 Mon Sep 17 00:00:00 2001 From: DA344 <108473820+DA-344@users.noreply.github.com> Date: Wed, 7 Aug 2024 01:19:16 +0200 Subject: [PATCH 02/14] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index dd95126..435d1c9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -20,3 +20,4 @@ WHEN MAKING A PR, REMOVE THIS LINE --> - [ ] PR contents come from a trusted source, such as DDeva Docs PR, [unofficial documentation](https://docs.discord.sex/), Discord staff mention, or others. - [ ] Changed files formatting works as expected. +- [ ] This is **not** a features code change. From 51d1b2d07841abe64a2230b1eaf0b916d50be245 Mon Sep 17 00:00:00 2001 From: DA344 <108473820+DA-344@users.noreply.github.com> Date: Wed, 7 Aug 2024 02:02:54 +0200 Subject: [PATCH 03/14] typo --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 435d1c9..aafd4e1 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -18,6 +18,6 @@ WHEN MAKING A PR, REMOVE THIS LINE --> -- [ ] PR contents come from a trusted source, such as DDeva Docs PR, [unofficial documentation](https://docs.discord.sex/), Discord staff mention, or others. +- [ ] PR contents come from a trusted source, such as DDevs Docs PR, [unofficial documentation](https://docs.discord.sex/), Discord staff mention, or others. - [ ] Changed files formatting works as expected. - [ ] This is **not** a features code change. From 92cac352ee8c203a189181b63bdc4cb4da9b4a57 Mon Sep 17 00:00:00 2001 From: DA344 <108473820+DA-344@users.noreply.github.com> Date: Wed, 7 Aug 2024 02:04:00 +0200 Subject: [PATCH 04/14] another typo --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index aafd4e1..4bffc20 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -16,7 +16,7 @@ WHEN MAKING A PR, REMOVE THIS LINE --> ## Checklist - + - [ ] PR contents come from a trusted source, such as DDevs Docs PR, [unofficial documentation](https://docs.discord.sex/), Discord staff mention, or others. - [ ] Changed files formatting works as expected. From 221e765c5a67f0716eed8c65b58cd89b80911dba Mon Sep 17 00:00:00 2001 From: DA344 <108473820+DA-344@users.noreply.github.com> Date: Wed, 7 Aug 2024 13:02:26 +0200 Subject: [PATCH 05/14] Create CONTRIBUTING.md --- .github/CONTRIBUTING.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..b922c91 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,21 @@ +## Contributing + +Before continuing, we wanted to thank you for your dedication if you want to contribute to this repository, +as you are helping other people have up-to-date information of discord.py's missing features. + +Now, here are the guidelines you need to follow to contribute to this project. + +## Creating Pull Requests + +When creating a pull request you must fill the template, which contains the following: + +- Brief Description: A short description that describes what the pull request has changed. +- Detailed Description: A detailed description of what the pull request has changed. +- Change Log: A list of the changes you've made to the repository files. +- Checklist: A checklist that has to be filled depending on what your PR does. + +## Opening Issues + +Issues can be used to ask questions or report bugs. Before opening an issue make sure that there aren't any duplicates, +please search your issue to see if there is already an open discussion about it. Duplicate issues will be closed after +redirecting you to the *original* one. From 2c8f9ce70565e8407c28a781e4705ee3453eee7d Mon Sep 17 00:00:00 2001 From: DA344 <108473820+DA-344@users.noreply.github.com> Date: Wed, 7 Aug 2024 13:05:34 +0200 Subject: [PATCH 06/14] Add a note to Creating Pull Requests --- .github/CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b922c91..9c34c7d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -14,6 +14,10 @@ When creating a pull request you must fill the template, which contains the foll - Change Log: A list of the changes you've made to the repository files. - Checklist: A checklist that has to be filled depending on what your PR does. +You also must make sure to provide a source to the Discord API Documentation or discord.py PR or any other "trusted" +source like a Discord Developer/Staff member, a well-known bot developer, a well-known library developer, etcetera. Or +if it is in the [Unofficial Discord API Documentation](https://docs.discord.sex/), you can also add it. + ## Opening Issues Issues can be used to ask questions or report bugs. Before opening an issue make sure that there aren't any duplicates, From f3445fd822a67d2589b118295076de0700db819e Mon Sep 17 00:00:00 2001 From: DA344 <108473820+DA-344@users.noreply.github.com> Date: Wed, 7 Aug 2024 13:07:19 +0200 Subject: [PATCH 07/14] Update README CONTRIBUTING --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index c8ab204..b2ccf13 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,7 @@ You will notice that each table has a status column, this column indicates the s ## Contributing -If you want to contribute to this repository, you can do so by creating a pull request. You can add a new feature, update an existing one or fix a mistake. If you want to add a new feature, please make sure to provide a source to the Discord API documentation, PR or any other "trusted" source like a Discord Developer / Staff member, a well-known bot developer or a well-known library developer. -Or if it's in the [Unofficial Discord API Documentation](https://docs.discord.sex/), you can also add it. - -Each feature is listed per category, matching the Discord API documentation and sorted alphabetically. If you want to add a new feature, please make sure to add it to the correct category and sort it alphabetically. +To see how to contribute in this library, take a look at [CONTRIBUTING.md](/.github/CONTRIBUTING.md) ## Features From e9970fc8177f23aa177afec0db0c97619e9ac89d Mon Sep 17 00:00:00 2001 From: DA344 <108473820+DA-344@users.noreply.github.com> Date: Wed, 7 Aug 2024 17:49:25 +0200 Subject: [PATCH 08/14] Apply soheab suggestion Co-authored-by: Soheab <33902984+Soheab@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b2ccf13..2942cec 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ You will notice that each table has a status column, this column indicates the s ## Contributing -To see how to contribute in this library, take a look at [CONTRIBUTING.md](/.github/CONTRIBUTING.md) +To see how to contribute in this repository, take a look at [CONTRIBUTING.md](/.github/CONTRIBUTING.md) ## Features From 9a6a0d8dce7dea9523e8a36e37426fdc40ec36ca Mon Sep 17 00:00:00 2001 From: DA344 <108473820+DA-344@users.noreply.github.com> Date: Wed, 7 Aug 2024 17:50:10 +0200 Subject: [PATCH 09/14] Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Soheab <33902984+Soheab@users.noreply.github.com> --- .github/PULL_REQUEST_TEMPLATE.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 4bffc20..ada8b7e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -8,11 +8,9 @@ ## Change Log - - + +- Example log 1 +- Example log 2 ## Checklist From 28451ce74c4665e5a65849a18edf2cee0661e9c9 Mon Sep 17 00:00:00 2001 From: DA344 <108473820+DA-344@users.noreply.github.com> Date: Wed, 7 Aug 2024 17:50:17 +0200 Subject: [PATCH 10/14] Update .github/CONTRIBUTING.md Co-authored-by: Soheab <33902984+Soheab@users.noreply.github.com> --- .github/CONTRIBUTING.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 9c34c7d..533b31f 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -14,9 +14,7 @@ When creating a pull request you must fill the template, which contains the foll - Change Log: A list of the changes you've made to the repository files. - Checklist: A checklist that has to be filled depending on what your PR does. -You also must make sure to provide a source to the Discord API Documentation or discord.py PR or any other "trusted" -source like a Discord Developer/Staff member, a well-known bot developer, a well-known library developer, etcetera. Or -if it is in the [Unofficial Discord API Documentation](https://docs.discord.sex/), you can also add it. +You must also include a source from the Discord API Documentation, a discord.py pull request, or any other reputable source such as a Discord Developer/Staff member, a well-known bot/library developer. Alternatively, if the information is available in the [Unofficial Discord API Documentation](https://docs.discord.sex/), feel free to reference it. ## Opening Issues From b81a8031597498e96d3b1ae340261315875e18d8 Mon Sep 17 00:00:00 2001 From: DA344 <108473820+DA-344@users.noreply.github.com> Date: Thu, 8 Aug 2024 13:12:02 +0200 Subject: [PATCH 11/14] Create MD to Wiki Workflow --- .github/workflows/md-to-wiki.yaml | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/workflows/md-to-wiki.yaml diff --git a/.github/workflows/md-to-wiki.yaml b/.github/workflows/md-to-wiki.yaml new file mode 100644 index 0000000..8da56ae --- /dev/null +++ b/.github/workflows/md-to-wiki.yaml @@ -0,0 +1,28 @@ +name: Update Features Wiki Page from FEATURES.md + +on: + push: + paths: + - 'FEATURES.md' + +jobs: + update-wiki: + runs-on: ubuntu-latest + + steps: + - name: Check the repo + uses: actions/checkout@v3 + + - name: Git config + run: | + git config --global user.name "github-actions" + git config --global user.email "github-actions@github.com" + + - name: Copy file to wiki + run: | + git clone "https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.wiki.git" wiki + cp FEATURES.md wiki/Features.md + cd wiki + git add Features.md + git commit -m "Push Features page from FEATURES.md" + git push From 32bd9169ddc7c022c0786cc0df0e33da940ed412 Mon Sep 17 00:00:00 2001 From: DA344 <108473820+DA-344@users.noreply.github.com> Date: Thu, 8 Aug 2024 18:11:07 +0200 Subject: [PATCH 12/14] Create config for MarkdownLint workflow --- .markdownlint.json | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .markdownlint.json diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..822875c --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,22 @@ +// Markdown Rules that are applied for the MarkDown checks +// Check https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md +// for the rules descriptions. +{ + "default": false, + "MD001": false, + "MD003": {"style": "atx"}, + "MD004": {"style": "dash"}, + "MD007": {"indent": 2, "start_indented": false}, + "MD011": true, + "MD018": true, + "MD019": true, + "MD022": {"lines_above": 0, "lines_below": 1}, + "MD039": true, + "MD040": {"language_only": false}, + "MD046": {"style": "fenced"}, + "MD047": true, + "MD048": {"style": "backtick"}, + "MD051": true, + "MD055": {"style": "leading_and_trailing"}, + "MD056": true +} From dbcaca2b3a4bd8bc049f8ab85d8fc3c28f808378 Mon Sep 17 00:00:00 2001 From: DA344 <108473820+DA-344@users.noreply.github.com> Date: Thu, 8 Aug 2024 18:18:23 +0200 Subject: [PATCH 13/14] Create MarkDown lint check workflow --- .github/workflows/md-lint.yaml | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 .github/workflows/md-lint.yaml diff --git a/.github/workflows/md-lint.yaml b/.github/workflows/md-lint.yaml new file mode 100644 index 0000000..6816a98 --- /dev/null +++ b/.github/workflows/md-lint.yaml @@ -0,0 +1,34 @@ +name: MarkDown Lint + +on: + push: + branches: + - main + pull_request: + paths: + - '**/*.md' + +jobs: + markdown-lint: + runs-on: ubuntu-latest + + steps: + - name: Repo Checkout + uses: actions/checkout@v3 + + - name: Install lint + run: npm install -g markdownlint-cli + + - name: Run lint + run: markdownlint '**/*.md' --config .markdownlint.json > markdownlint-output.txt || true + + - name: Check lint failures + run: | + if [[ -s markdownlint-output.txt ]]; then + echo "MarkDown Lint issues found:" + cat markdownlint-output.txt + exit 1 + else + echo "No issues found" + fi + From 508b4f41dd2b34efd2c4ccb7de727b62f672272d Mon Sep 17 00:00:00 2001 From: DA344 <108473820+DA-344@users.noreply.github.com> Date: Thu, 8 Aug 2024 18:22:48 +0200 Subject: [PATCH 14/14] Limit MD to Wiki workflow to main --- .github/workflows/md-to-wiki.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/md-to-wiki.yaml b/.github/workflows/md-to-wiki.yaml index 8da56ae..335e147 100644 --- a/.github/workflows/md-to-wiki.yaml +++ b/.github/workflows/md-to-wiki.yaml @@ -2,6 +2,8 @@ name: Update Features Wiki Page from FEATURES.md on: push: + branches: + - main paths: - 'FEATURES.md'