Skip to content

Latest commit

 

History

History
57 lines (35 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

57 lines (35 loc) · 1.91 KB

Contributing to 3D Maze

Thank you for your interest in contributing to the 3D Maze project! Your contributions are valuable and help improve the project for everyone. Here's how you can get started:

Getting Started

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine using:
git clone https://github.com/YOUR-USERNAME/3DMaze.git
  1. Create a new branch for your feature or bugfix:
git checkout -b feature_your-feature-name

Development Setup

  1. Ensure you have Unity 2021 or higher installed on your machine.
  2. Run the project locally.

Coding Guidelines

  • Follow the C# coding conventions as outlined in the Microsoft C# Coding Conventions.
  • Keep code changes concise and focused.
  • Write clear, descriptive commit messages.

Submitting Changes

  1. Ensure all tests pass before submitting a pull request.
  2. Update documentation as needed.
  3. Push your branch to your forked repository:
git push origin feature_your-feature-name
  1. Open a pull request against the main branch of the original repository.

Reporting Issues

If you find a bug or have a feature request, please open an issue on GitHub. Provide as much detail as possible to help us address the issue quickly.

Lead Project Maintainer

Occular Malice is the lead project maintainer. Feel free to reach out to him for any significant inquiries or guidance regarding 3D Maze.

Code of Conduct

We adhere to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.

License

By contributing to the 3D Maze project, you agree that your contributions will be licensed under the MIT License.