|
| 1 | +# Contributing to LLMUnity |
| 2 | + |
| 3 | +:+1: :tada: :heart: Thanks for your interest! :heart: :tada: :+1: |
| 4 | + |
| 5 | +The following is a set of guidelines for contributing to [LLMUnity](https://github.com/undreamai/LLMUnity). These are just guidelines, not rules. Use your best judgment, and |
| 6 | +feel free to propose changes to this document in a pull request. |
| 7 | + |
| 8 | +#### Table Of Contents |
| 9 | + |
| 10 | +[How Can I Contribute?](#how-can-i-contribute) |
| 11 | + * [Code of Conduct](#code-of-conduct) |
| 12 | + * [Set up your dev environment](#set-up-your-dev-environment) |
| 13 | + * [Reporting Bugs](#reporting-bugs) |
| 14 | + * [Suggesting Enhancements](#suggesting-enhancements) |
| 15 | + * [Good First Issue](#good-first-issue) |
| 16 | + * [Issue and Pull Request Labels](#issue-and-pull-request-labels) |
| 17 | + |
| 18 | + |
| 19 | +## How Can I Contribute? |
| 20 | + |
| 21 | +### Code of Conduct |
| 22 | + |
| 23 | +This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md). |
| 24 | +By participating, you are expected to uphold this code. |
| 25 | + |
| 26 | +### Set up your dev environment |
| 27 | + |
| 28 | + |
| 29 | +1. Fork the repo. |
| 30 | +2. Clone your forked repo into a Unity project's `Assets`. |
| 31 | +3. Create a symbolic link to `Samples~`, for example with: |
| 32 | + ```bash |
| 33 | + cd Assets && ln -s ./LLMUnity/Samples~ ./Samples |
| 34 | + ``` |
| 35 | +4. Add the package to your projects libraries `Packages/manifest.json`: |
| 36 | + ```json |
| 37 | + "ai.undream.llm": "file:path/to/project/Assets/LLMUnity", |
| 38 | + ``` |
| 39 | +5. Create a topic branch from where you want to base your work. |
| 40 | +Name your branch prefixed with an appropriate [label](https://github.com/undreamai/LLMUnity/labels), following the naming convention `enhancement/*`, `bug/*`, `documentation/*`, etc. Make commits of logical units. |
| 41 | +6. Set up pre-commit hooks with `sh ./.github/setup.sh` |
| 42 | + |
| 43 | + |
| 44 | +### Reporting Bugs |
| 45 | + |
| 46 | +This section guides you through submitting a bug report for LLMUnity. |
| 47 | +Following these guidelines helps maintainers and the community understand your |
| 48 | +report :pencil:, reproduce the behavior :computer:, and find related |
| 49 | +reports :mag_right:. |
| 50 | + |
| 51 | +Before creating bug reports, please check [this section](#before-submitting-a-bug-report) |
| 52 | +as you might find out that you don't need to create one. When you are creating |
| 53 | +a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report) as it helps us resolve issues faster. |
| 54 | + |
| 55 | +#### Before Submitting A Bug Report |
| 56 | + |
| 57 | +**Perform a [cursory search](https://github.com/undreamai/LLMUnity/labels/bug)** |
| 58 | +to see if the problem has already been reported. If it does exist, add a |
| 59 | +[reaction](https://help.github.com/articles/about-discussions-in-issues-and-pull-requests/#reacting-to-ideas-in-issues-and-pull-requests) |
| 60 | +to the issue to indicate this is also an issue for you, and add a |
| 61 | +comment to the existing issue if there is extra information you can contribute. |
| 62 | + |
| 63 | +#### How Do I Submit A (Good) Bug Report? |
| 64 | + |
| 65 | +Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). |
| 66 | + |
| 67 | +Simply create an issue on the [LLMUnity issue tracker](https://github.com/undreamai/LLMUnity/issues), choose the appropriate provided issue template and fill it out. |
| 68 | + |
| 69 | +The information we are interested in includes: |
| 70 | + |
| 71 | + - details about your environment - which build, which operating system |
| 72 | + - details about reproducing the issue - what steps to take, what happens, how |
| 73 | + often it happens |
| 74 | + - other relevant information - log files, screenshots, etc. |
| 75 | + |
| 76 | +### Suggesting Enhancements |
| 77 | + |
| 78 | +This section guides you through submitting an enhancement suggestion for |
| 79 | +LLMUnity, including completely new features and minor improvements to |
| 80 | +existing functionality. Following these guidelines helps maintainers and the |
| 81 | +community understand your suggestion :pencil: and find related suggestions |
| 82 | +:mag_right:. |
| 83 | + |
| 84 | +Before creating enhancement suggestions, please check [this section](#before-submitting-an-enhancement-suggestion) |
| 85 | +as you might find out that you don't need to create one. When you are creating |
| 86 | +an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). |
| 87 | + |
| 88 | +#### Before Submitting An Enhancement Suggestion |
| 89 | + |
| 90 | +**Perform a [cursory search](https://github.com/undreamai/LLMUnity/labels/enhancement)** |
| 91 | +to see if the enhancement has already been suggested. If it has, add a |
| 92 | +:thumbsup: to indicate your interest in it, or comment if there is additional |
| 93 | +information you would like to add. |
| 94 | + |
| 95 | +#### How Do I Submit A (Good) Enhancement Suggestion? |
| 96 | + |
| 97 | +Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). |
| 98 | + |
| 99 | +Simply create an issue on the [LLMUnity issue tracker](https://github.com/undreamai/LLMUnity/issues), choose the appropriate provided issue template and fill it out and provide the following information: |
| 100 | + |
| 101 | +* **Use a clear and descriptive title** for the issue to identify the |
| 102 | + suggestion. |
| 103 | +* **Provide a step-by-step description of the suggested enhancement** in as |
| 104 | + much detail as possible. This additional context helps the maintainers to |
| 105 | + understand the enhancement from your perspective |
| 106 | +* **Explain why this enhancement would be useful** to LLMUnity users. |
| 107 | +* **Include screenshots and animated GIFs** if relevant to help you demonstrate |
| 108 | + the steps or point out the part of LLMUnity which the suggestion is |
| 109 | + related to. You can use [this tool](http://www.cockos.com/licecap/) to record |
| 110 | + GIFs on macOS and Windows. |
| 111 | +* **List some other applications where this enhancement exists, if applicable.** |
| 112 | + |
| 113 | +### Good First Issue |
| 114 | + |
| 115 | +We'll identify enhancements or bugs that can be categorized as tasks that: |
| 116 | + |
| 117 | + - have low impact, or have a known workaround |
| 118 | + - should be fixed |
| 119 | + - have a narrow scope and/or easy reproduction steps |
| 120 | + - can be worked on independent of other tasks |
| 121 | + |
| 122 | +These issues will be labelled as [`good-first-issue`](https://github.com/undreamai/LLMUnity/labels/good%20first%20issue) |
| 123 | +in the repository. If you are interested in contributing to the project, please |
| 124 | +comment on the issue to let the maintainers (and community) know you are |
| 125 | +interested in picking this up. |
| 126 | + |
| 127 | +### Issue and Pull Request Labels |
| 128 | + |
| 129 | +See [this page](https://github.com/undreamai/LLMUnity/labels) for the list of the labels we use to help us track and manage issues and pull requests. |
| 130 | + |
| 131 | + |
| 132 | + |
| 133 | + |
0 commit comments