mirrors-yuzu-emu/discord-open-source
1
0
Fork 0
mirror of https://github.com/yuzu-emu/discord-open-source synced 2024-11-24 11:48:28 +00:00
Code Issues Projects Releases Packages Wiki Activity

Adds acceptance criteria and reorganizes instructions

Browse source
This commit is contained in:
John Furrow 2018-04-04 16:10:27 -07:00
parent 85c52b0db4
commit 71e3c893c8
1 changed files with 24 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -1,12 +1,29 @@
# Open Source Communities on Discord
This is the source list of OSS communities that use and live on Discord. It is used to populate the list at https://discordapp.com/open-source.
To add your project and community to the list:
* Fork the repo
* Add your logo into `/logos`
-- Logos should be 40x40 SVGs
* Add your community to communities.json like so:
Thanks for being part of Discord!
## Acceptance criteria
At this time, we are accepting communities which meet the following criteria:
1. Your community is not Discord-focused (for example, Discord bots or modifications are not accepted).
2. Your community has at least 1,000 members, or the GitHub repo has at least 1,000 stars.
3. Your community adheres to the [Discord community guidelines](https://discordapp.com/guidelines).
While this list does not currently extend to Discord bots, look forward to something for bots in the future.
## Adding your project
1. Fork the repo
2. Add your logo into [`/logos`](https://github.com/discordapp/discord-open-source/tree/master/logos)
* Logo dimensions should be either `72x72` for SVG or `144x144` for PNG.
* Logo should be minified.
* SVGs should contain only vector shapes — no raster graphics.
3. Add your community to [`communities.json`](https://github.com/discordapp/discord-open-source/blob/master/communities.json), like so:
```json
{
@ -15,12 +32,8 @@ To add your project and community to the list:
"quote": "Optional: A short quote about how you use Discord for your project.",
"quoteSourceUrl": "Optional: An optional source for the quote.",
"inviteCode": "The public invite code to your project, usually the code after https://discord.gg/",
"githubUrl": "The URL of your Github organization or project repository."
"githubUrl": "The URL of your GitHub organization or project repository."
}
```
* Submit a PR with your change and, if all is OK, we'll merge it and pull it in!
Thanks for being part of Discord!
This list does not currently extend to Discord bots, but look forward to something for bots in the future.
4. Submit a PR with your change, and if all is well, we'll merge it and display it on Discord's [open source page](https://discordapp.com/open-source)!