Skip to content

Latest commit

 

History

History
107 lines (78 loc) · 4.28 KB

CONTRIBUTING.md

File metadata and controls

107 lines (78 loc) · 4.28 KB
Raw

Contributing to Tau LLM Unity ML Agents Project

Thank you for considering contributing to the Tau LLM Unity ML Agents Project! We welcome contributions from the community to help improve and expand this project. Please take a moment to review this document to understand how you can contribute effectively.

Table of Contents

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

How to Contribute

Reporting Bugs

If you find a bug in the project, please open an issue on GitHub. Include as much detail as possible to help us understand and reproduce the issue. Please use the following template:

  • Title: A brief description of the bug.
  • Description: A detailed description of the bug.
  • Steps to Reproduce: A list of steps to reproduce the bug.
  • Expected Behavior: What you expected to happen.
  • Actual Behavior: What actually happened.
  • Screenshots: If applicable, add screenshots to help explain your problem.
  • Environment: Information about your environment (e.g., OS, Unity version, etc.).

Suggesting Enhancements

If you have an idea for an enhancement or new feature, please open an issue on GitHub. Describe your idea in detail and explain why it would be beneficial to the project. Please use the following template:

  • Title: A brief description of the enhancement.
  • Description: A detailed description of the enhancement.
  • Benefits: Explain why this enhancement would be beneficial.
  • Additional Context: Any additional context or screenshots.

Submitting Pull Requests

If you would like to contribute code to the project, please follow these steps:

  1. Fork the Repository: Click the "Fork" button at the top of the repository page to create a copy of the repository in your GitHub account.
  2. Clone the Repository: Clone your forked repository to your local machine. 
    git clone https://github.com/p3nGu1nZz/Tau.git
cd Tau\MLAgentsProject
  3. Create a Branch: Create a new branch for your feature or bug fix. 
    git checkout -b feature/your-feature-name
  4. Make Changes: Make your changes to the codebase.
  5. Commit Changes: Commit your changes with a descriptive commit message. 
    git commit -m "Add feature: your feature name"
  6. Push Changes: Push your changes to your forked repository. 
    git push origin feature/your-feature-name
  7. Open a Pull Request: Open a pull request to the main repository. Provide a detailed description of your changes and any relevant information.

Development Setup

To set up your development environment, follow these steps:

  1. Clone the Repository: Clone the repository to your local machine. 
    git clone https://github.com/p3nGu1nZz/Tau.git
cd tau/MLAgentsProject
  2. Install Dependencies: Install the required Python packages and environment. 
    .\Scripts\setup.bat
  3. Open the Unity Project: Launch Unity Hub and open the project folder.

Style Guides

Coding Standards

Please adhere to the following coding standards:

Commit Messages

Please use clear and descriptive commit messages. Follow these guidelines:

  • Format: Use the format Add feature: your feature name.
  • Description: Provide a brief description of the changes made.

License

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

Thank you for your contributions! If you have any questions, feel free to open an issue or contact the project maintainers.