Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

59 lines (43 loc) · 2.74 KB

How to contribute

First off, thanks for taking the time to contribute! 🎉🎉👍

You know a client or mod that isn't on our list ? 📝

Open a new Github issue or pull request with your suggestion. Ensure the issue description accurately point out the name, link, features, language and development status of the client or mod if applicable.

Please be aware of the following things when making suggestions:

  1. Avoid making duplicate suggestions. Please use the GitHub issue search feature to check if your proposition has been mentioned in the past. Duplicate issues are a huge maintenance burden on the limited resources of the project. If it is clear from your report that you would have struggled to find the original, that's ok, but if searching for a selection of words in your issue title would have found the duplicate then the issue will likely be closed extremely abruptly.

  2. Make sure that the information you provided is accurate and if the project does not says it's archived or discontinued, it will be marked as on hiatus. 👍

🔥 Important: All of the entries are ordered alphabetically. Hence, while contributing, make sure to order to add the new entry in an alphabetical order.

What if a language is missing from our badges list ?

Just as the clients and mods, you can open a new Github issue or pull request with your suggestion.

  1. Copy this markdown 👇:
    • Table line: | <name> | [![<name>][<name>-Badge]][<name>-Url] | `[![<name>][<name>-Badge]][<name>-Url]` |
    • Link references:
[<name>-Badge]: <badge link>
[<name>-Url]: <wikipedia page> "<name>"
  1. Replace the following:

  2. Add the table line to badges.md, and make sure to put it in the right alphabetical position.

  3. Add the link references at the end of badges.md and README.md, and also make sure to position it alphabetically.


Thanks! again to ALL the amazing contributors! 🙏