FMHY-Website/.github/CONTRIBUTING.md

How to Contribute to FMHY

[!INFO] NOTE Some of these steps are easier if you're in our Discord. It opens every Friday.

Here you'll find some general guidelines for those who would like to start contributing. There are multiple ways to do this:

• Link Submissions
• Reporting an Existing Site
• How to Edit and Preview Changes
• Finding New Sites

Submissions

[!INFO] NOTE For bigger changes to the wiki, such as debloating efforts or the restructuring of a page/section, you must first discuss these with us via Discord before opening a Pull Request.

Adding a Site

For submitting new links, follow these steps:

• Before submitting a link, make sure it's not already added. The easiest way to do this is to check our Single Page using ctrl+f.
• You can optionally include socials, tools, or any other additional info alongside the entry.
• Reach out via the feedback system, by opening an Issue, or join our Discord.
• Avoid opening pull requests. See Link Testing for more info.

Don't submit any of the following:

• 🕹️ Emulators - Already listed on the Game Tech Wiki.
• 🌐 Web Browsers - Already listed on Comparison and Index Sites. However, we accept privacy-based ones as well as normal Android browsers.
• 🔻 Leeches - Unless already listed on existing Leech Lists, don't submit these.
• 🐧 Linux Distros - They're already on DistroWatch.
• 🌍 Non-english Software - We don't add non-english software sites (APKs, games, torrents, etc.) unless they have a very good reputation.
• 🗂️ Coding Libraries - There's too many of them and there are better places to find them.
• 🎲 Mining / Betting Sites - Don't submit anything related to betting, mining, BINs, CCs, etc.
• 🎮 Multiplayer Hacks - Don't submit any hacks or exploits that give an unfair advantage in multiplayer games.
• 🖥️ Custom OS's - We don't recommend people use these.

Reporting a Site

[!INFO] NOTE If it's urgent, you're allowed to request an invite via our feedback system.

For changes to existing entries, follow these steps:

• Reach out via any of the available methods, including opening a Pull Request.
• Feel free to leave contact info when using the feedback system, if needed. Only trusted staff can view this.
• If you'd like to report a site removal or star change, you must include details for why you think the changes you're suggesting should be accepted.

Link Testing

All additions have to first go through our testing process on Discord.

You can help us test new sites to figure out their use-case, safety, and whether they'd be a good fit for the wiki.

Keep in mind certain sites (such as piracy sites) require more testing/vetting before they can be added.

Formatting Rules

The wiki will always have some variation either due to exceptions being made, the layout/structure, or the flexible nature of markdown itself.

For these reasons, there are too many conditions and nuances to satisfy to make an easy-to-follow guide. However, you can generally get an idea by looking at how existing links are structured.

If you're unsure, ask in the wiki channels on Discord and wait for a staff member to reply.

Making Changes

Instructions on various ways to edit the wiki and preview changes.

GitHub Editor

You can use the build-in web editor in two ways:

1. Fork the repository by clicking the "Fork" button in the top right corner.

2. Now, you can open it in a VSCode-like environment by pressing . (period) on your fork's homepage, which will take you to github.dev.

OR

1. Find the file you want to edit, look for the "Edit" icon (of a pencil) and click on it, then make your changes.

   

2. When you're done, click "Commit Changes..." then "Propose changes". Optionally add a commit description.

3. You should now see a comparison page showing all your edits. Click "Create pull request", fill in the box describing your changes and provide details if needed, then hit submit.

GitHub Codespaces

To use GitHub Codespaces, follow these steps:

1. Fork the repository by clicking the "Fork" button in the top right corner.

2. Now, click on the "Code" button on the top right corner of the page and select "Codespaces" from the dropdown menu.

3. Make your changes.

4. To close the workspace, click the "Code" button in the top right corner, then click "Stop Codespace" and hit enter.

Local Instance

[!INFO] NOTE Making changes on a local repository requires a basic understanding of Git. You can find learning resources here.

If you're going to work on the site itself, or simply want to make changes with instant site feedback, you can setup a development environment and run FMHY locally.

More info on selfhosting can be found here.