diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..cf541b909 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# -> **The Contribution Guide** <- + +### Link Submission Guide + +**1.** Before submitting a link, please **[search](https://redd.it/105xraz)** to make sure it's not already in the wiki. + +**2.** The order of priority is: **Site > GitHub > Store Link** +Please only use the store link if there's neither a site nor a GitHub available for the app/extension you'd like to submit. + +**3.** Always check to see if the site you'd like to submit has a Discord / Telegram server you can link with it. + +**4.** Find a suitable category for the link and then submit it by making a **[Pull Request](https://github.com/fmhy/FMHYedit/pulls)**. + +!!!info If you don't know how to make a Pull Request, you can follow **[this guide](https://rentry.org/fmhyedit)**. + +!!!warning If you haven't tested the link you'd like to submit, especially if it's a DDL site, please open an **[Issue](https://github.com/fmhy/FMHYedit/issues)** or reach out to us on **[Discord](https://discord.gg/5W9QJKuPkD)** rather than making a Pull Request. + +#### Don't Submit: + +**đŸ•šī¸ Emulators** +They're already on the **[Game Tech Wiki](https://emulation.gametechwiki.com/index.php/Main_Page)**. + +**đŸ”ģ Leeches** +They're already on the **[File Hosting Wiki](https://filehostlist.miraheze.org/wiki/Free_Premium_Leeches)**. + +**🐧 Distros** +They're already on **[DistroWatch](https://distrowatch.com/)**. + +**🎲 Mining / Betting Sites** +Don't post anything related to betting, mining, BINs, CCs, etc. + +**🎮 Multiplayer Game Hacks** +Don't post any hacks/exploits that give unfair advantages in multiplayer games. + +### How to Report a Site + +**1.** Open an **[Issue](https://github.com/fmhy/FMHYedit/issues)** or a **[Pull Request](https://github.com/fmhy/FMHYedit/pulls)** and make sure to explain why you think the site(s) in question should be removed, unstarred, and/or changed. + +**2.** Alternatively, you can reach out to us on **[Discord](https://discord.gg/5W9QJKuPkD)** if you're unsure whether the site should be reported or if you'd like to discuss your report with more people. + +!!!info If you want to make bigger changes to the wiki, such as debloating or restructuring a page/section, it's recommended to first discuss those changes with us via **[Discord](https://discord.gg/5W9QJKuPkD)** and then make a **[Pull Request](https://github.com/fmhy/FMHYedit/pulls)**.