Skip to content

Commit 4fea7ff

Browse files
authored
Redesign contributors.md
1 parent e6de938 commit 4fea7ff

File tree

1 file changed

+112
-56
lines changed

1 file changed

+112
-56
lines changed

contributors.md

Lines changed: 112 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,114 @@
1-
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
2-
[contributorsBadge]: https://img.shields.io/badge/Contributors_✨-10-green.svg?style=plastic
3-
<!-- ALL-CONTRIBUTORS-BADGE:END -->
1+
[all-contributors]: https://allcontributors.org
2+
[emojis]: https://allcontributors.org/docs/en/emoji-key
3+
4+
<!-- Austin Keener -->
5+
[dv8fromtheworld]: https://github.com/DV8FromTheWorld
6+
[jda]: https://github.com/DV8FromTheWorld/JDA
7+
8+
<!-- Ben Manes -->
9+
[benmanes]: https://github.com/ben-manes
10+
[caffeine]: https://github.com/ben-manes/Caffeine
11+
12+
<!-- CodeMC -->
13+
[codemc]: https://github.com/codemc
14+
15+
<!-- Dave -->
16+
[davidrockin]: https://github.com/DavidRockin
17+
[david_comment]: https://github.com/botblock/JavaBotBlockAPI/pull/3#issuecomment-522036554
18+
19+
<!-- Dependabot -->
20+
[dependabot]: https://github.com/Dependabot
21+
22+
<!-- Ghost_chu -->
23+
[ghostchu]: https://github.com/ghost-chu
24+
[ghostchu_commits]: https://github.com/botblock/JavaBotBlockAPI/commits?author=ghost-chu
25+
26+
<!-- Javacord -->
27+
[javacord]: https://github.com/javacord
28+
[javacord-lib]: https://github.com/javacord/Javacord
29+
30+
<!-- Sean Leary -->
31+
[stleary]: https://github.com/stleary
32+
[json-java]: https://github.com/stleary/JSON-java
33+
34+
<!-- Square -->
35+
[square]: https://github.com/square
36+
[okhttp]: https://github.com/square/OkHttp
437

538
# Contributors
6-
![contributorsBadge]
7-
8-
We appreciate any kind of contribution to the JavaBotBlockAPI, as it is our goal to improve over time.
9-
10-
Contributions aren't just limited to PRs or code examples.
11-
Bug reports, suggestions or general feedback to upcoming features are always apreciated and welcome.
12-
13-
# Emoji keys
14-
We use different Emojis as "Keys" to summarize what kind of contributions are under this category.
15-
16-
Below can you see a list of all currently listed emojis, their category and meaning.
17-
A full list of all available categories can be found [here](https://allcontributors.org/docs/en/emoji-key).
18-
19-
- 🤔 (Ideas)
20-
Suggesting new features, improvements or giving general feedback.
21-
- 🔌 (Plugin)
22-
Developed a library used by this project.
23-
- 🚇 (Infra)
24-
Provides a site, service or similar that is used by the project (e.g. CI-Server).
25-
- 🚧 (Maintenance)
26-
Helps maintaining this project, being it updating dependencies, or adding new features.
27-
- 📖 (Documentation)
28-
Helped updating or improving the documentation of this project.
29-
- 💻(Code)
30-
Contributed Code to improve the Project.
31-
32-
# List of contributors
33-
Below can you find a list of all currently aknowledged Contributors to our project.
34-
35-
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
36-
<!-- prettier-ignore-start -->
37-
<!-- markdownlint-disable -->
38-
<table>
39-
<tr>
40-
<td align="center"><a href="https://tkachuk.tech"><img src="https://avatars1.githubusercontent.com/u/1907079?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Dave</b></sub></a><br /><a href="#ideas-DavidRockin" title="Ideas, Planning, & Feedback">🤔</a></td>
41-
<td align="center"><a href="http://linkedin.dv8tion.net"><img src="https://avatars1.githubusercontent.com/u/1479909?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Austin Keener</b></sub></a><br /><a href="#plugin-DV8FromTheWorld" title="Plugin/utility libraries">🔌</a></td>
42-
<td align="center"><a href="https://ci.codemc.io/"><img src="https://avatars2.githubusercontent.com/u/37156340?v=4?s=100" width="100px;" alt=""/><br /><sub><b>CodeMC</b></sub></a><br /><a href="#infra-CodeMC" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
43-
<td align="center"><a href="https://dependabot.com"><img src="https://avatars1.githubusercontent.com/u/27347476?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Dependabot</b></sub></a><br /><a href="#maintenance-dependabot" title="Maintenance">🚧</a></td>
44-
<td align="center"><a href="https://www.linkedin.com/in/benmanes"><img src="https://avatars3.githubusercontent.com/u/378614?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ben Manes</b></sub></a><br /><a href="#plugin-ben-manes" title="Plugin/utility libraries">🔌</a></td>
45-
<td align="center"><a href="https://square.github.io"><img src="https://avatars0.githubusercontent.com/u/82592?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Square</b></sub></a><br /><a href="#plugin-square" title="Plugin/utility libraries">🔌</a></td>
46-
<td align="center"><a href="https://www.jetbrains.com"><img src="https://avatars2.githubusercontent.com/u/878437?v=4?s=100" width="100px;" alt=""/><br /><sub><b>JetBrains</b></sub></a><br /><a href="#plugin-JetBrains" title="Plugin/utility libraries">🔌</a></td>
47-
</tr>
48-
<tr>
49-
<td align="center"><a href="http://www.johnjleary.com"><img src="https://avatars3.githubusercontent.com/u/5107558?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sean Leary</b></sub></a><br /><a href="#plugin-stleary" title="Plugin/utility libraries">🔌</a></td>
50-
<td align="center"><a href="https://www.caseyjbrooks.com/"><img src="https://avatars2.githubusercontent.com/u/6157866?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Casey Brooks</b></sub></a><br /><a href="https://github.com/botblock/JavaBotBlockAPI/commits?author=cjbrooks12" title="Code">💻</a> <a href="https://github.com/botblock/JavaBotBlockAPI/commits?author=cjbrooks12" title="Documentation">📖</a></td>
51-
<td align="center"><a href="http://blog.mcsunnyside.com"><img src="https://avatars.githubusercontent.com/u/30802565?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ghost_chu</b></sub></a><br /><a href="https://github.com/botblock/JavaBotBlockAPI/commits?author=Ghost-chu" title="Code">💻</a></td>
52-
</tr>
53-
</table>
54-
55-
<!-- markdownlint-restore -->
56-
<!-- prettier-ignore-end -->
57-
58-
<!-- ALL-CONTRIBUTORS-LIST:END -->
39+
We aknowledge all contributions made to the project, be it Pull requests or even something simple like feedback and/or suggestions.
40+
41+
To thank every contributor did we adobt the [All Contributors][all-contributors] system and adjusted it slightly.
42+
This page lists every user/organisation who contributed to the project in some way. Please see the [Categories](#categories) below for an explanation about the different Emojis and their meaning.
43+
44+
## Categories
45+
This file follows a similar system like the All Contributors [Emoji Key System][emojis].
46+
Each Category has their own emoji which is listed here.
47+
48+
### 💻 Code
49+
Contributed code towards the project.
50+
This can be through Pull requests or, if having the rights for, through direct commits.
51+
52+
Will have a link to all commits made by this User/Bot/Organisation.
53+
54+
### 🤔 Feedback/Ideas
55+
Gave Ideas and or general feedback to improve the project.
56+
Will have links to all issues, Pull requests, Discussions and general comments the User/Organisation made.
57+
58+
### 🚇 Infrastructure
59+
Provides a place to host the project, jar files, documentation or similar.
60+
A common example would be a CI (Jenkins) Server.
61+
62+
### 🚧 Maintenance
63+
Helps keeping the project running through actions such as keeping dependencies up to date.
64+
65+
### 🔌 Plugin(s)
66+
Provides one or multiple dependencies used by the project.
67+
A link to the Project(s) will be provided.
68+
69+
## Contributors
70+
Here is a list of all the Contributors to our project and how they contributed to this project.
71+
72+
### [Austin Keener][dv8fromtheworld]
73+
74+
> Contributions: [🔌](#plugins "Plugin(s)") ([JDA])
75+
76+
----
77+
### [Ben Manes][benmanes]
78+
79+
> Contribution: [🔌](#plugins "Plugin(s)") ([Caffeine])
80+
81+
----
82+
### [CodeMC][codemc]
83+
84+
> Contributions: [🚇](#infrastructure "Infrastructure")
85+
86+
----
87+
### [Dave][davidrockin]
88+
89+
> Contributions: [🤔](#feedbackideas "Feedback/Ideas") ([#3 (Comment)][david_comment])
90+
91+
----
92+
### [Dependabot]
93+
94+
> Contributions: [🚧](#maintenance "Maintenance")
95+
96+
----
97+
### [Ghost_chu][ghostchu]
98+
99+
> Contributions: [💻](#code "Code") ([Commits][ghostchu_commits])
100+
101+
----
102+
### [Javacord]
103+
104+
> Contribution: [🔌](#plugins "Plugin(s)") ([Javacord][javacord-lib])
105+
106+
----
107+
### [Sean Leary][stleary]
108+
109+
> Contribution: [🔌](#plugins "Plugin(s)") ([JSON-java][json-java])
110+
111+
----
112+
### [Square][square]
113+
114+
> Contribution: [🔌](#plugins "Plugin(s)") ([OkHttp])

0 commit comments

Comments
 (0)