rework contributing guide

apacheli · Jul 14, 2022 · 639e74b · 639e74b
1 parent b38c84f
commit 639e74b
Show file tree

Hide file tree

Showing 5 changed files with 69 additions and 4 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1 +1,64 @@
 # Contributing Guide
+
+Hello, thank you for taking a look at our contributing guide. This manual will guide you to adding your library to this list. If you are adding a library of which you do not own, please ask for permission from their maintainer(s) first.
+
+### Requirements
+
+- Must be an open-source project hosted on a known Git platform (e.g., GitHub, GitLab, Bitbucket, etc).
+- Must **not** be written in an [esoteric programming language](https://en.wikipedia.org/wiki/Esoteric_programming_language).
+- Must be about using the Discord API as the main proof of concept.
+
+### Setting Up
+
+- Clone the repository: `$ git clone https://github.com/apacheli/discord-api-libs`
+- Make the necessary changes
+- (optional) Run `node .` to view the new `README.md`
+- Commit and push your changes
+- Create a pull request
+
+### Formats
+
+We are now using [JSON](https://www.json.org/json-en.html) when it comes to providing information about a library. Copy the example below, paste it into `./libs/`, and make sure the filename matches the `name` field (e.g., `eris.json` and `"name": "eris"`).
+
+```jsonc
+{
+  // The library's name.
+  "name": "",
+  // A description of the library.
+  // You can also just use the "About" section of the library's repository.
+  "description": "",
+  // The language the library is written in.
+  "language": "",
+  // Can be GitHub, GitLab, Bitbucket, etc.
+  "repository_url": "",
+  // Extra metadata.
+  "tags": [
+    // Can also mean deprecated.
+    "archived",
+    "fork",
+    "wrapper"
+  ],
+  // The features of the Discord API the library supports.
+  "features": [
+    "gateway",
+    "interactions",
+    "rest",
+    "rpc",
+    "webhooks",
+    "voice"
+  ]
+}
+```
+
+If you are adding a library that is written in an entirely programming language, do not forget to add a language JSON file too! Follow the same steps as adding a library, but paste the file into `./langs/`.
+
+```jsonc
+{
+  // The language's name.
+  "name": "",
+  // The libraries written for the language.
+  "libraries": [],
+  // The official website of the language.
+  "website": ""
+}
+```
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 🚀 **A curated list of Discord API libraries developed by members of the community** 🚀
 
-Want to help contribute to this project? Take a look at [our contributing guide](./CONTRIBUTING.md).
+Want to help contribute to this project? Take a look at [our contributing guide](https://github.com/apacheli/discord-api-libs/blob/master/CONTRIBUTING.md).
 
 ### Resources
 

diff --git a/libs/DisCatSharp.json b/libs/DisCatSharp.json
@@ -3,7 +3,9 @@
   "description": "A cute Discord API wrapper for .NET with the newest stuff.",
   "language": "C#",
   "repository_url": "https://github.com/Aiko-IT-Systems/DisCatSharp",
-  "tags": [],
+  "tags": [
+    "fork"
+  ],
   "features": [
     "gateway",
     "interactions",

diff --git a/main.mjs b/main.mjs
@@ -39,7 +39,7 @@ let str = `# Discord API Libraries
 
 🚀 **A curated list of Discord API libraries developed by members of the community** 🚀
 
-Want to help contribute to this project? Take a look at [our contributing guide](./CONTRIBUTING.md).
+Want to help contribute to this project? Take a look at [our contributing guide](https://github.com/apacheli/discord-api-libs/blob/master/CONTRIBUTING.md).
 
 ### Resources
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "discord-api-libs",
   "version": "1.0.0",
-  "description": "Discord API Community Libraries",
+  "description": "Discord API Libraries 🚀",
   "main": "./main.mjs"
 }