Skip to content

Commit c41604c

Browse files
author
Lorenzo Toniazzi
committed
Add contributing guidelines
1 parent f87e8c4 commit c41604c

File tree

4 files changed

+221
-0
lines changed

4 files changed

+221
-0
lines changed

CODE_OF_CONDUCT.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting a project team member. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

CODE_OF_CONDUCT.md.meta

+7
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

CONTRIBUTING.md

+133
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
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+

CONTRIBUTING.md.meta

+7
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)