‼️Contributing

Find here all the information you need to help us modify this wiki

Welcome! This guide will walk you step by step through the contribution process to the EpicWorld project wiki on GitHub.

📋 Prerequisites

⚙️ Install and Configure Git

After installation, open your terminal and configure your name and email (the ones used for GitHub):

git config --global user.name "Your Name"
git config --global user.email "[email protected]"

🚀 Make a Contribution

1. Fork the Repository

  • Click on the Fork button in the top right to create a copy of the repository on your account.

2. Clone Your Fork to Your Computer

Copy the link to your fork and run the following command in your terminal:

git clone https://github.com/YOUR-USERNAME/wiki-epicworld.git
cd wiki-epicworld

3. Create a New Branch

Create a separate branch for each topic you work on to keep your contributions organized:

git checkout -b branch-name

Example: git checkout -b add-capture-guide

4. Edit the Wiki

  • Use Visual Studio Code to edit markdown (.md) files.

  • You can also create new files, for example, how-to-claim.md.

Example of a simple markdown structure:

# Main Title

## Subtitle

Your content here...

- Bullet list item
- Second point

[A useful link](http://example.com)

5. Add Your Changes to Git

In your terminal, add and commit your changes:

git add .
git commit -m "Added guide on dungeons"

6. Push Your Contribution

Send your changes to GitHub:

git push origin branch-name

7. Open a Pull Request (PR)

  • Go back to your forked project on GitHub.

  • Click on Compare & pull request.

  • Clearly describe your contribution and then confirm by clicking Create pull request.

💡 Best Practices and Tips

  • Keep your explanations clear and concise.

  • Check spelling and grammar.

  • Structure your markdown pages properly.

  • Use Visual Studio Code’s markdown previews (Ctrl + Shift + V) before submitting.

🛠️ If You Encounter Issues

Feel free to create an issue on GitHub to ask for help or to raise a question.

Thank you for your contribution! ✨

Last updated