-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
131 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
## Brief Description | ||
|
||
<!-- Briefly explain your PR --> | ||
|
||
## Detailed Description | ||
|
||
<!-- Explain with as much detail as possible your PR --> | ||
|
||
## Change Log | ||
|
||
<!-- List the changes you made, does not have to be in any particular order --> | ||
- Example log 1 | ||
- Example log 2 | ||
|
||
## Checklist | ||
|
||
<!-- Check the boxes with [x] for those items that your PR meets --> | ||
|
||
- [ ] 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 "[email protected]" | ||
- 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters