First off, thank you for considering contributing to CreatureChat™! It's people like you that make the Minecraft modding community such a great place to be a part of. Here are a few guidelines that we ask contributors to follow to make the process easy and effective for everyone involved.
Before you begin:
- Ensure you have a GitHub account linked to your email.
- Familiarize yourself with the GitHub Flow to understand our branch management and release structure.
- Make sure you have a basic understanding of the Fabric modding platform.
-
Fork the Repository
- Fork the project repository: https://github.com/CreatureChat/creature-chat
- Clone your fork to your local machine and set up the development environment as described in INSTALL.md.
-
Create a Branch
- Create a new branch from where you want to base your work.
- Use a clear branch name that describes the intent of your changes.
-
Make Your Changes
- Make the changes in your fork following the coding conventions and guidelines.
- Commit your changes. Keep your commits as small as possible but include complete and informative commit messages.
-
Test Your Changes
- Ensure your changes do not break any existing functionality.
- Test your changes thoroughly, making sure they provide the functionality described in your branch name.
-
Push Changes
- Push your changes to your fork on GitHub.
-
Pull Request
- Make sure your branch is up to date with the main project branch you are targeting.
- Submit a pull request to the main repository in the appropriate branch.
- Include a descriptive title and a detailed first comment describing what your changes do.
-
Review Process
- Other contributors and maintainers will review your pull request. Be open to discussing potential improvements.
- Make any requested changes to your pull request. This might require more commits.
-
Final Review and Merge
- Once your pull request is approved, a project maintainer will merge it.
You’re welcome to fork CreatureChat™ under the project’s GNU GPL v3 for source code.
Branding, art, documentation, screenshots, and other non-code assets are licensed under the Creative Commons
Attribution–NonCommercial 4.0 International license (see LICENSE-ASSETS.md).
That means you may reuse them only for non-commercial purposes and must provide attribution.
You may reference the project’s name in phrases such as “Fork of CreatureChat”, provided such use is purely descriptive and does not imply endorsement or official affiliation.
If you publish a fork on Modrinth, CurseForge, or elsewhere:
- Use a different name and branding.
- Credit the original project.
- State clearly that your fork is unofficial.
- Bugs are tracked as GitHub issues. Create an issue on our repository and clearly describe the bug with as much detail as possible, steps to reproduce, expected outcome, and actual outcome.
- Join our Discord to chat with other contributors and get help with your development questions.
Thank you for your contributions to the CreatureChat™ mod!