Skip to content

Commit 45480bd

Browse files
authored
Merge pull request #502 from ai16z/dev
chore: add contributor license
2 parents 14b28d3 + d1e4dc0 commit 45480bd

File tree

4 files changed

+258
-189
lines changed

4 files changed

+258
-189
lines changed

CONTRIBUTING.md

+72-19
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,38 @@
11
# Contributing to Eliza
22

3-
First off, thank you for considering contributing to Eliza! It's people like you that make Eliza such a great tool. We welcome contributions from everyone, regardless of their experience level.
3+
First off, thank you for considering contributing to Eliza! We welcome contributions from everyone, regardless of experience level.
44

5-
## Code of Conduct
5+
## Contribution License Agreement
66

7-
By participating in this project, you are expected to uphold our Code of Conduct. Please report unacceptable behavior.
7+
By contributing to Eliza, you agree that your contributions will be licensed under the MIT License. This means:
88

9-
## How Can I Contribute?
9+
1. You grant us (and everyone else) a perpetual, worldwide, non-exclusive, royalty-free license to use your contributions.
10+
2. Your contributions are and will be available as Free and Open Source Software (FOSS).
11+
3. You have the right to submit the work under this license.
12+
4. You understand that your contributions are public and that a record of the contribution is maintained indefinitely.
1013

11-
### Reporting Bugs
14+
## The OODA Loop: A Framework for Contribution
1215

13-
1. Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/ai16z/eliza/issues).
14-
2. If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/ai16z/eliza/issues/new). Be sure to include
16+
We believe in the power of the OODA Loop - a decision-making framework that emphasizes speed and adaptability. OODA stands for:
1517

16-
- a title and clear description,
17-
- as much relevant information as possible, and
18-
- a code sample or an executable test case demonstrating the expected behavior that is not occurring.
18+
- **Observe**: Gather information and insights about the project, the community, and the broader AI ecosystem.
19+
- **Orient**: Analyze your observations to identify opportunities for contribution and improvement.
20+
- **Decide**: Choose a course of action based on your analysis. This could be proposing a new feature, fixing a bug, or creating content.
21+
- **Act**: Execute your decision and share your work with the community.
1922

20-
### Suggesting Enhancements
23+
## How to Contribute
2124

22-
1. Open a new issue with a clear title and detailed description of the suggested enhancement.
23-
2. Include any relevant examples or mock-ups if applicable.
25+
### For Developers
2426

25-
### Pull Requests
27+
1. **Extend Eliza's Capabilities**
28+
- Develop new actions, evaluators, and providers
29+
- Improve existing components and modules
30+
31+
2. **Enhance Infrastructure**
32+
- Review open issues and submit PRs
33+
- Test and update documentation
34+
- Optimize performance
35+
- Improve deployment solutions
2636

2737
1. Fork the repo and create your branch from `main`.
2838
1. The name of the branch should start with the issue number and be descriptive of the changes you are making.
@@ -64,12 +74,55 @@ This section lists the labels we use to help us track and manage issues and pull
6474
- `documentation` - Issues or pull requests related to documentation.
6575
- `good first issue` - Good for newcomers.
6676

67-
## Recognition
6877

69-
We value every contribution. Contributors will be recognized in our README.md file. Significant contributions may be acknowledged with special roles or responsibilities within the project.
78+
## Getting Help
79+
80+
- Join [Discord](https://discord.gg/ai16z)
81+
- Check [FAQ](docs/community/faq.md)
82+
- Create GitHub issues
83+
84+
## Additional Resources
85+
86+
- [Local Development Guide](docs/guides/local-development.md)
87+
- [Configuration Guide](docs/guides/configuration.md)
88+
- [API Documentation](docs/api)
89+
90+
## Contributor Guide
91+
92+
Welcome to the Eliza contributor guide! This document is designed to help you understand how you can be part of building the future of autonomous AI agents, regardless of your technical background.
93+
94+
### Code of Conduct
95+
96+
#### Our Pledge
97+
98+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
99+
100+
#### Our Standards
101+
102+
Examples of behavior that contributes to creating a positive environment include:
103+
104+
- Using welcoming and inclusive language
105+
- Being respectful of differing viewpoints and experiences
106+
- Gracefully accepting constructive criticism
107+
- Focusing on what is best for the community
108+
- Showing empathy towards other community members
109+
110+
Examples of unacceptable behavior include:
111+
112+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
113+
- Trolling, insulting/derogatory comments, and personal or political attacks
114+
- Public or private harassment
115+
- Publishing others' private information without explicit permission
116+
- Other conduct which could reasonably be considered inappropriate in a professional setting
117+
118+
#### Our Responsibilities
119+
120+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
121+
122+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
70123

71-
## Questions?
124+
#### Scope
72125

73-
If you have any questions, please feel free to contact the project maintainers with an issue or in discord.
126+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
74127

75-
Thank you for your interest in contributing to Eliza!
128+
Thank you for contributing to Eliza and helping build the future of autonomous AI agents! 🎉

docs/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Eliza
1+
# Eliza - Multi-agent simulation framework
2+
# https://github.com/ai16z/eliza
3+
# Visit https://eliza.builders for support
4+
# dev branch
25

36
<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
47

0 commit comments

Comments
 (0)