diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 963740672..b40f3ae80 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,25 +1,25 @@ # How to Edit FMHY -There are two ways you can contribe to this repository: +There are three ways you can contribute to this repository: - [Link submissions](#submitting-a-link) - [Reporting a site](#reporting-a-site) -- Changes to the website itself +- [Changes to the website itself](#making-changes) -### Submitting a Link +## Submitting a Link > [!IMPORTANT] > 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. -**1.** Before submitting a link, please **[search](https://redd.it/105xraz)** to make sure it's not already in the wiki. +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 > Git Repository > Store Link** +2. The order of priority is: **Site > Git Repository > Store Link** Please only use the store link if there's neither a site nor a Git repository 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. +3. Always check to see if the site you'd like to submit has a Discord / Telegram server you can link with it. -**4.** Never edit the single-page, it contains all the pages of the wiki and gets updated automatically. +4. Never edit the single-page, it contains all the pages of the wiki and gets updated automatically. -**5.** Find a suitable category for the link and then submit it by making a **[Pull Request](https://github.com/fmhy/FMHYedit/pulls)**. +5. Find a suitable category for the link and then submit it by making a **[Pull Request](https://github.com/fmhy/FMHYedit/pulls)**. #### Don't Submit: @@ -38,7 +38,7 @@ 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. -### Reporting a Site +## Reporting a Site > [!TIP] > If you want to make bigger changes to the wiki, such as debloating or restructuring a page/section, please discuss those changes with us via **[Discord](https://discord.gg/5W9QJKuPkD)** before making a **[Pull Request](https://github.com/fmhy/FMHYedit/pulls)**. @@ -49,18 +49,58 @@ You can do one of the following: - 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. -### Editing FMHY +## Making changes -**Step 1.** Click the page you want to edit on **[FMHYedit](https://github.com/fmhy/FMHYedit)**. +If you want to make changes with instant site feedback, or are simply going to work with the site, you can do so with these 3 ways: -**Step 2.** Select edit button and make your changes. +- [Using gitpod.io or GitHub Codespaces (recommended)](#using-gitpodio-or-github-codespaces) +- [Using the GitHub editor](#using-the-github-editor) +- [Manually setting up a development environment](#manually-setting-up-a-development-environment) +> [!TIP] +> You can just use our [💬 Discord](https://redd.it/17f8msf) to send us sites or any changes. + +### Using gitpod.io or GitHub Codespaces + +You can also use [gitpod.io](https://gitpod.io/) or [GitHub Codespaces](https://github.com/features/codespaces) to edit the wiki. + +Follow these steps: + +1. Fork the repository by clicking the "Fork" button in the top right corner. + +2. Now, to make changes, you can either use gitpod.io or GitHub Codespaces. + +#### Gitpod.io +Login to your GitHub account and click on the "New Workspace" button. Then select your fork and you should be in your gitpod workspace. + +To close the workspace, click on the "Gitpod" button at the bottom left corner then type "Stop Workspace" and hit enter. + +#### GitHub Codespaces +Click on the "Code" button on the top right corner of the page and select "Codespaces" from the dropdown menu. + +### Using the GitHub editor + +1. Fork the repository by clicking the "Fork" button in the top right corner. You can open your repository in a VSCode-like environment by pressing `.` (dot) in your fork's homepage which will take you to `github.dev`. + +2. Find the file you want to edit. Find the "Edit" icon (of a pencil) and click on it. +Select edit button and make your changes. ![Select edit button](https://i.imgur.com/lnQfeo3.png) -**Step 3.** Scroll down and select "propose changes," and "create pull request" on the next page. +3. Scroll down and select "Propose changes", and "Create Pull Request" on the next page. -![propose changes](https://i.imgur.com/IaSJvnO.png) **>>>** ![create pull request](https://i.imgur.com/z5Za72l.png) +![propose changes](https://i.imgur.com/IaSJvnO.png) +![create pull request](https://i.imgur.com/z5Za72l.png) -Keep in mind you can press `.` on a repos page to open it in VScode for easier editing. +### Manually setting up a development environment -You can also just use our [💬 Discord](https://redd.it/17f8msf) to send us sites or any changes. +1. Fork the repository by clicking the "Fork" button in the top right corner. + +2. Make sure you have [Node.js](https://nodejs.org/en/), [git](https://git-scm.com/), and [VSCode](https://code.visualstudio.com/) or any other editor installed. + +3. Clone your forked repository to your local machine. + +4. Open the cloned repository in your editor of choice. Find the file you want to work on, make changes. + +5. Add your changes with git (`git add `) and commit (`git commit -m "commit message"`), then push them (`git push`). + +6. Create a pull request by clicking the "New Pull Request" button in your forked repository.