Thank you for considering contributing to the Ultimate Starter Kit! This repository is aimed at speeding up the development of Unreal Engine games and is open to collaboration from the community.
We welcome contributions in the form of code, documentation, bug reports, feature requests, and more. By contributing to this project, you're helping make game development using Unreal Engine more accessible and efficient.
Make sure you read the full documentation available here. The Markdown documentation is also included in the repo under the docs directory you can also refer to it offline.
To contribute to the Ultimate Starter Kit, please follow these guidelines:
-
Fork the Repository: Click the "Fork" button at the top right of this repository to create your own fork.
-
Clone Your Fork: Clone your fork of the repository to your local development environment using the following command:
git clone https://github.com/your-username/Ultimate-Starter-Kit.git
3.Create a New Branch: Before making any changes, create a new branch for your contribution. Please choose a descriptive name for your branch.
git checkout -b feature/new-feature4.Make Changes: Make your desired changes or contributions to the project.
5.Testing: If you are introducing new features or making changes, ensure that you test your changes to confirm they work as intended. We encourage unit tests, integration tests, or any other relevant testing methodology.
6.Documentation: If your changes affect user documentation, be sure to update or create the necessary documentation to explain the changes.
7.Commit Your Changes: Commit your changes with a clear and concise message that explains the purpose of the change.
git commit -m "Add feature: [Your Feature Name]"8.Push Your Changes: Push your changes to your fork on GitHub.
git push origin feature/new-feature9.Open a Pull Request: Go to the original repository, and on the main page, you should see a "Compare & pull request" button. Click it and provide a clear and detailed description of your changes. Make sure to reference any related issues or pull requests.
10.Review and Discussion: Be prepared for discussions and potential code review. Address any comments or feedback received during the review process.
11.Merge: Once your pull request is approved, it will be merged into the main repository. Congratulations on your contribution!
We expect all contributors to follow our Code of Conduct. Please be respectful and considerate when interacting with other community members.
If you encounter bugs, or issues, or have feature requests, please open a new issue on the GitHub repository. Provide detailed information about the problem you're experiencing or the feature you'd like to see. Make sure you are using Unreal Engine 4.27 and newer versions.
If you need help or have questions about contributing to the Ultimate Starter Kit, feel free to reach out to us through the issue tracker or contact me through Mastodon or Twitter. You can also send me an Email at.
We appreciate your interest in contributing to the Ultimate Starter Kit and look forward to your valuable contributions!
Thank you for being part of our community.