mirror of
https://github.com/fmhy/edit.git
synced 2025-08-01 00:32:30 +10:00
97 lines
No EOL
5.1 KiB
Markdown
97 lines
No EOL
5.1 KiB
Markdown
# How to Contribute to FMHY
|
|
|
|
> [!INFO] NOTE
|
|
> Some of these steps are easier if you're in our [Discord](https://rentry.co/fmhy-invite). 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](#additions)
|
|
- [Reporting an Existing Site](#reporting-a-site)
|
|
- [How to Edit and Preview Changes](#making-changes)
|
|
- [Finding New Sites](https://www.reddit.com/r/FREEMEDIAHECKYEAH/wiki/find-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](https://rentry.co/fmhy-invite) before opening a [Pull Request](https://github.com/fmhy/edit/pulls).
|
|
|
|
### Adding a Site
|
|
|
|
Before submitting a link, please [Search](https://redd.it/105xraz) to make sure it's not already added. The easiest way to do this is to check our [Single Page](https://api.fmhy.net/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 on any page of the site, by opening an [Issue](https://github.com/fmhy/edit/issues), or join our [Discord](https://rentry.co/fmhy-invite). Avoid opening pull requests, as all additions have to first go through our testing process on Discord.
|
|
|
|
**Don't submit any of the following:**
|
|
- **🕹️ Emulators** - Already listed on the [Game Tech Wiki](https://emulation.gametechwiki.com/index.php/Main_Page).
|
|
- **🌐 Web Browsers** - Already listed on [Comparison and Index Sites](/internet-tools#browser-tools). However, we accept privacy-based ones as well as normal Android browsers.
|
|
- **🔻 Leeches** - Unless already listed on existing [Leech Lists](../downloadpiracyguide#leeches-debrid), don't submit these.
|
|
- **🐧 Linux Distros** - They're already on [DistroWatch](https://distrowatch.com/).
|
|
- **🌍 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](https://github.com/fmhy/edit/pulls).
|
|
- 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 site(s) in question should be changed.
|
|
|
|
### 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](https://rentry.co/fmhy-invite) 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](https://github.com/features/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](/edupiracyguide#developer-learning).
|
|
|
|
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](/other/selfhosting.md). |