Contributing
Thank you for your interest in contributing to UI Tweaks! We welcome contributions of all kinds, including bug fixes, new features, documentation improvements, and more. Here are some guidelines to help you get started:
- Fork the repository: Click the “Fork” button at the top right of the repository page to create your own copy of the project.
- Create a new branch: It’s best to create a new branch for your changes. This keeps your work separate from the main codebase and makes it easier to manage pull requests.
- Make your changes: Implement your changes in your branch. Be sure to follow the existing code style and conventions.
- Test your changes: Make sure to test your changes thoroughly to ensure they work as expected and do not introduce new issues.
- Commit your changes: Write clear and concise commit messages that describe the changes you made.
- Push your changes: Push your branch to your forked repository on GitHub.
- Create a pull request: Go to the original repository and click the “New pull request” button. Select your branch and provide a clear description of your changes and why they are needed.
- Respond to feedback: The maintainers may provide feedback or request changes to your pull request. Please be responsive and willing to make adjustments as needed.
- Celebrate your contribution: Once your pull request is merged, congratulations! You’ve contributed to the project and helped make it better for everyone. Your name should also appear in the contributors list on the GitHub repository.
We also encourage you to check out our issues page for any open issues or feature requests that you might be interested in working on.
Tips for contributing
- Start small: If you’re new to contributing, consider starting with small bug fixes or documentation improvements to get familiar with the process.
- Communicate: If you’re unsure about how to implement a feature or fix a bug, don’t hesitate to ask for help in the issues or discussions sections.
- Be respectful: Remember that open source is a collaborative effort. Be respectful and considerate in your interactions with other contributors and maintainers.
- Have fun: Contributing to open source can be a rewarding experience. Enjoy the process and the opportunity to learn and grow as a developer!
Additional resources
- BitzArt-VS Discord server - Join our community to discuss UI Tweaks, ask questions, and get help with your contributions.
- Vintage Story modding: Getting Started - A guide on how to get started with modding Vintage Story from the official wiki.
- GitHub’s guide to contributing - A comprehensive guide on how to contribute to projects on GitHub.