|
1 | 1 | # Contributing to Eliza
|
2 | 2 |
|
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. |
4 | 4 |
|
5 |
| -## Code of Conduct |
| 5 | +## Contribution License Agreement |
6 | 6 |
|
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: |
8 | 8 |
|
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. |
10 | 13 |
|
11 |
| -### Reporting Bugs |
| 14 | +## The OODA Loop: A Framework for Contribution |
12 | 15 |
|
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: |
15 | 17 |
|
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. |
19 | 22 |
|
20 |
| -### Suggesting Enhancements |
| 23 | +## How to Contribute |
21 | 24 |
|
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 |
24 | 26 |
|
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 |
26 | 36 |
|
27 | 37 | 1. Fork the repo and create your branch from `main`.
|
28 | 38 | 1. The name of the branch should start with the issue number and be descriptive of the changes you are making.
|
@@ -64,12 +74,17 @@ This section lists the labels we use to help us track and manage issues and pull
|
64 | 74 | - `documentation` - Issues or pull requests related to documentation.
|
65 | 75 | - `good first issue` - Good for newcomers.
|
66 | 76 |
|
67 |
| -## Recognition |
68 | 77 |
|
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 |
70 | 83 |
|
71 |
| -## Questions? |
| 84 | +## Additional Resources |
72 | 85 |
|
73 |
| -If you have any questions, please feel free to contact the project maintainers with an issue or in discord. |
| 86 | +- [Local Development Guide](docs/guides/local-development.md) |
| 87 | +- [Configuration Guide](docs/guides/configuration.md) |
| 88 | +- [API Documentation](docs/api) |
74 | 89 |
|
75 |
| -Thank you for your interest in contributing to Eliza! |
| 90 | +Thank you for contributing to Eliza and helping build the future of autonomous AI agents! 🎉 |
0 commit comments