Skip to content

Commit 019a162

Browse files
authored
Update CONTRIBUTING.md
1 parent eb3d6d1 commit 019a162

File tree

1 file changed

+35
-9
lines changed

1 file changed

+35
-9
lines changed

CONTRIBUTING.md

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,48 @@ Whether you're submitting a new plugin, fixing typos, or enhancing existing entr
1010
## How to Contribute
1111

1212
1. **Fork the repository**
13-
Click the "Fork" button on the top right of the repository page to create a copy of this repository on your GitHub account.
14-
<img src="./Assets/Contributing/Fork.png" alt="Fork Button" width="125">
13+
Click the **Fork** button at the top right of this page to create a copy of this repository on your own GitHub account.
14+
![Fork Button](./Assets/Contributing/Fork.png)
1515

1616
2. **Clone the repository**
17-
Clone the forked repository to your local machine.
18-
<img src="./Assets/Contributing/Clone.jpg" alt="Clone Button" width="250">
17+
Clone your forked repository to your local development machine using Git.
18+
![Clone Button](./Assets/Contributing/Clone.jpg)
1919

2020
3. **Create a new branch**
21-
Create a new branch for your contribution.
22-
<img src="./Assets/Contributing/NewBranch.png" alt="Create Branch" width="100">
21+
Always create a new branch for your changes before committing.
22+
![Create Branch](./Assets/Contributing/NewBranch.png)
2323

2424
4. **Add your plugin or theme**
25-
Open the `data/plugins-and-themes.yml` file and add your plugin or theme entry in the appropriate section.
25+
Open the `data/plugins-and-themes.yml` file and add your plugin or theme in the appropriate section:
26+
- Add plugin entries under the `plugins:` section.
27+
- Add theme entries under the `themes:` section.
2628

27-
5. **Validate your changes**
28-
Make sure your `plugins-and-themes.yml` file is valid YAML. You can use tools like [YAML Lint](https://www.yamllint.com/) to verify formatting.
29+
Follow the format used in existing entries. Each entry must include:
30+
- `name`
31+
- `repo`
32+
- `description`
33+
- `creator`:
34+
- `name`
35+
- `url`
36+
- `avatar`
37+
- `latest_release_tag`
38+
- `screenshots` (can be an empty list)
39+
- For plugins:
40+
- `mc_versions`
41+
- `is_core` (true or false)
42+
43+
5. **Push and create a pull request**
44+
Push your branch and open a pull request targeting the `main` branch.
45+
46+
6. **Check GitHub Actions**
47+
Your pull request will automatically run a validation check.
48+
If it fails, visit the **Actions** tab to view the error details and fix any issues.
49+
50+
> [!TIP]
51+
> If everything is correct, the markdown files (`PLUGINS.md`, `THEMES.md`, and `README.md`) will be automatically updated on merge.
52+
53+
> [!NOTE]
54+
> You no longer need to manually validate YAML — it's automatically handled by `validate-yml.py` and checked via GitHub Actions.
2955
3056
### Example Plugin Format (with screenshots):
3157
```yaml

0 commit comments

Comments
 (0)