search

magemonkeystudio / fabled

Fabled - A skill casting plugin with custom skill builder
https://fabled.magemonkey.studio
MIT License
59 stars 39 forks source link

[Enhancement]: Add Setup Guide for New Contributors #992

Open that-ar-guy opened 2 days ago

that-ar-guy commented 2 days ago

Description:

Currently, there is no clear documentation explaining how new contributors can set up and run the project locally. To make onboarding easier, a step-by-step guide should be added to the README.md or as a separate file (e.g., CONTRIBUTING.md).

Proposed Solution:

Add a section in the documentation that includes the following steps:

  1. Cloning the Repository: Provide the command to clone the repository.

    git clone https://github.com/magemonkeystudio/fabled.git   ```
2.**Building the Project Using Maven:** Guide the user on how to build the project using Maven.
Copy code
```bash
mvn clean install

3.Deploying the Plugin to a Minecraft Server: Instructions to copy the generated JAR file from target/ to the plugins/ folder of a Spigot/Paper Minecraft server.

4.Configuring the Plugin: Direct contributors to the Fabled Editor for plugin configuration.

  1. Starting the Server to Test: Guide to start the Minecraft server and check if the plugin is loaded successfully.

Optional: Add screenshots or terminal output showing the output of a successful build and the plugin being loaded on the server.

Benefits: Makes it easier for new contributors to get started. Reduces onboarding friction. Improves documentation quality.

Task List: -[ ] Write the guide for local setup. -[ ] Update the README.md or create a CONTRIBUTING.md.

Travja commented 2 days ago

I do need to get a CONTRIBUTING.md put together for this, though I don't think we need to go quite as in depth on things like copying the compile jar to a server or the server setup itself. If people are wanting to contribute, they likely have some development knowledge, and better have server knowledge.

that-ar-guy commented 2 days ago

Hi @Travja ,I’m a new open-source contributor currently focusing on documentation and would love to help draft the CONTRIBUTING.md. I can keep it simple and relevant for contributors with development or server knowledge. Let me know if that works!

Travja commented 1 day ago

I think if you want to put together a basic setup,that would be great. I can fill in gaps and flesh it out more afterwards.

that-ar-guy commented 1 day ago

Hey @Travja, I’ve created a pull request with a CONTRIBUTING.md file to guide new contributors in setting up and running the project locally. Please review the PR at your convenience. Let me know if there are any changes or additions you'd like me to make. Happy to iterate as needed!