Skip to content

Commit

Permalink
feat(.github/ISSUE_TEMPLATE): add new suggestion issue template to en…
Browse files Browse the repository at this point in the history
…courage community suggestions

refactor(.github/workflows/lint.yaml): remove white-list parameter from awesome_bot command for simplicity
chore(ci/.github/workflows/lint.yaml): remove redundant lint workflow file from ci directory
chore(readme-template.md): delete unused readme template file
feat(readme.md): update readme content to reflect the project's focus on Discord.py
  • Loading branch information
kzndotsh committed Jul 15, 2024
1 parent 226455b commit b8c5da5
Show file tree
Hide file tree
Showing 5 changed files with 57 additions and 132 deletions.
File renamed without changes.
2 changes: 1 addition & 1 deletion .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ jobs:
- name: "install awesome-bot"
run: gem install awesome_bot
- name: "linting: ${{ matrix.files }}"
run: awesome_bot --allow-redirect --white-list https://github.com/YOUR_GITHUB_USER/YOUR_REPO ${{ matrix.files }}
run: awesome_bot --allow-redirect ${{ matrix.files }}
45 changes: 0 additions & 45 deletions ci/.github/workflows/lint.yaml

This file was deleted.

59 changes: 0 additions & 59 deletions readme-template.md

This file was deleted.

83 changes: 56 additions & 27 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,59 @@
# Awesome List Template

This is an [awesome-list](https://github.com/sindresorhus/awesome) template with
CI to run [awesome-lint](https://github.com/sindresorhus/awesome-lint) and
[awesome_bot](https://github.com/dkhamsing/awesome_bot) to be compliant from the
beginning.

## Usage

1. [generate a template of this repo](https://github.com/jthegedus/awesome-list-template/generate)
2. run a find & replace of `YOUR_GITHUB_USER/YOUR_REPO` with your details
3. edit `readme-template.md`
- update the h1 title
- update the subtitle
- update the description
- add img src, make it link to the site of the thing in the image.
4. choose a CI template
- GitHub Action: move config folder from `repo-root/ci/.github/` to
`repo-root/.github`
- Circle CI: move config folder from `repo-root/ci/.circleci/*` to
`repo-root/.circleci/*`
- GitLab CI: move config file from `repo-root/ci/.gitlab-ci.yml` to the
`repo-root/.gitlab-ci.yml`
5. run a find & replace `readme-template.md` to `readme.md` in the CI you chose
5. delete this file
6. rename `readme-template.md` file to `readme.md`
<div align="center">

<!-- title -->

<!--lint ignore no-dead-urls-->

# Awesome Discord.py [![Awesome](https://awesome.re/badge.svg)](https://awesome.re) [![lint](https://github.com/kzndotsh/awesome-discordpy/actions/workflows/lint.yaml/badge.svg)](https://github.com/kzndotsh/awesome-discordpy/actions/workflows/lint.yaml)

<!-- subtitle -->

An Awesome list for all things Discord.py

<!-- image -->

<a href="" target="_blank" rel="noopener noreferrer">
<img style="width: 50%" src="https://discordpy.readthedocs.io/en/stable/_images/snake_dark.svg" />
</a>

<!-- description -->
<br>
<br>

[Discord.py](https://discordpy.readthedocs.io/en/stable/) is a modern, easy to use, feature-rich, and async ready API wrapper for Discord.

</div>

<!-- TOC -->

## Contents

- [Featured (new releases)](#featured-new-releases)
- [Section 1](#section-1)
- [Follow](#follow)

<!-- CONTENT -->

## Featured (new releases)

- [Apple](https://apple.com) - Apple as a placeholder.

## Section 1

- [Microsoft](https://www.microsoft.com/) - Microsoft as an example.

<!-- END CONTENT -->

## Follow

<!-- list people worth following on social sites (Twitter, LinkedIn, GitHub, YouTube etc.) -->

Who else should we be following!?

## Contributing

Contributions welcome!
[Contributions of any kind welcome, just follow the guidelines](contributing.md)!

### Contributors

[Thanks goes to these contributors](https://github.com/kzndotsh/awesome-discordpy/graphs/contributors)!

0 comments on commit b8c5da5

Please sign in to comment.