diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..533b31f --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,23 @@ +## 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. + +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 + +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. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..ada8b7e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,21 @@ +## Brief Description + + + +## Detailed Description + + + +## Change Log + + +- Example log 1 +- Example log 2 + +## 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. +- [ ] This is **not** a features code change. 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 + diff --git a/.github/workflows/md-to-wiki.yaml b/.github/workflows/md-to-wiki.yaml new file mode 100644 index 0000000..335e147 --- /dev/null +++ b/.github/workflows/md-to-wiki.yaml @@ -0,0 +1,30 @@ +name: Update Features Wiki Page from FEATURES.md + +on: + push: + branches: + - main + 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 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 +} diff --git a/README.md b/README.md index a20e31a..324f307 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 repository, take a look at [CONTRIBUTING.md](/.github/CONTRIBUTING.md) ## Features