Thank you for helping out making the Mucklet Client better!
If you are new to this project, first get to know the code base a bit.
- Try to install and run it locally, connecting to the test server.
- Read the Understanding the application documentation to learn more.
- Try to create a simple module to see how that works.
Did it work? Great! Now we are ready to contribute.
While there are thousands of great ideas that would make the game better, for now we ask that you focus on the ones that has been added to the list of issues. If you see a suitable one, drop a comment on it to let others know you are planning on working on it.
If you have a feature idea not listed, use the below steps:
- Post your idea under Wolfery Forum - Bugs & Features
- Let the rest of the community provide input on your idea
- If approved, Accipiter will add the feature as an issue
- Make a branch and start coding!
Note
Bugs, spelling mistakes, or other issues that doesn't require new features, concepts, or structures, can be contributed without the input from the community.
You may create a pull request directly.
The project repository uses git flow as branching system. When you fork and create a branch, make use to base it on the develop branch, which is the one we work on.
The master branch is mainly just for releases.
The style guide explains things like code formatting, code rules, and common patterns used in the project. Don't let the size of the file scare you off. Most of it are examples. The most important points are:
- Use an ESLint plugin for your IDE.
- Use an EditorConfig plugin for your IDE.
- Follow the conventions you see in the rest of the code.
No worries if your pull request does not follow all the rules. Just be willing to edit your code if asked, or allow someone else to make sure your code follows the rules.
When you are finished with the changes, create a pull request:
- Make sure to link to the issue to make it easier to find.
- Be prepared that you might be asked to make some changes before approval.
- Be prepared that Accipiter might do changes to your code after merge as well.
Congrats! And thanks for your contribution!