|
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** |
26 | 28 |
|
27 |
| -1. Fork the repo and create your branch from `main`. |
| 29 | + - Develop new actions, evaluators, and providers |
| 30 | + - Improve existing components and modules |
| 31 | + |
| 32 | +2. **Enhance Infrastructure** |
| 33 | + |
| 34 | + - Review open issues and submit PRs |
| 35 | + - Test and update documentation |
| 36 | + - Optimize performance |
| 37 | + - Improve deployment solutions |
| 38 | + |
| 39 | +3. Fork the repo and create your branch from `main`. |
28 | 40 | 1. The name of the branch should start with the issue number and be descriptive of the changes you are making.
|
29 | 41 | 1. eg. 40--add-test-for-bug-123
|
30 |
| -2. If you've added code that should be tested, add tests. |
31 |
| -3. Ensure the test suite passes. |
32 |
| -4. Make sure your code lints. |
33 |
| -5. Issue that pull request! |
| 42 | +4. If you've added code that should be tested, add tests. |
| 43 | +5. Ensure the test suite passes. |
| 44 | +6. Make sure your code lints. |
| 45 | +7. Issue that pull request! |
34 | 46 |
|
35 | 47 | ## Styleguides
|
36 | 48 |
|
@@ -64,12 +76,54 @@ This section lists the labels we use to help us track and manage issues and pull
|
64 | 76 | - `documentation` - Issues or pull requests related to documentation.
|
65 | 77 | - `good first issue` - Good for newcomers.
|
66 | 78 |
|
67 |
| -## Recognition |
| 79 | +## Getting Help |
| 80 | + |
| 81 | +- Join [Discord](https://discord.gg/ai16z) |
| 82 | +- Check [FAQ](docs/community/faq.md) |
| 83 | +- Create GitHub issues |
| 84 | + |
| 85 | +## Additional Resources |
| 86 | + |
| 87 | +- [Local Development Guide](docs/guides/local-development.md) |
| 88 | +- [Configuration Guide](docs/guides/configuration.md) |
| 89 | +- [API Documentation](docs/api) |
| 90 | + |
| 91 | +## Contributor Guide |
| 92 | + |
| 93 | +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. |
| 94 | + |
| 95 | +### Code of Conduct |
| 96 | + |
| 97 | +#### Our Pledge |
| 98 | + |
| 99 | +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. |
| 100 | + |
| 101 | +#### Our Standards |
| 102 | + |
| 103 | +Examples of behavior that contributes to creating a positive environment include: |
| 104 | + |
| 105 | +- Using welcoming and inclusive language |
| 106 | +- Being respectful of differing viewpoints and experiences |
| 107 | +- Gracefully accepting constructive criticism |
| 108 | +- Focusing on what is best for the community |
| 109 | +- Showing empathy towards other community members |
| 110 | + |
| 111 | +Examples of unacceptable behavior include: |
| 112 | + |
| 113 | +- The use of sexualized language or imagery and unwelcome sexual attention or advances |
| 114 | +- Trolling, insulting/derogatory comments, and personal or political attacks |
| 115 | +- Public or private harassment |
| 116 | +- Publishing others' private information without explicit permission |
| 117 | +- Other conduct which could reasonably be considered inappropriate in a professional setting |
| 118 | + |
| 119 | +#### Our Responsibilities |
| 120 | + |
| 121 | +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. |
68 | 122 |
|
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. |
| 123 | +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. |
70 | 124 |
|
71 |
| -## Questions? |
| 125 | +#### Scope |
72 | 126 |
|
73 |
| -If you have any questions, please feel free to contact the project maintainers with an issue or in discord. |
| 127 | +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. |
74 | 128 |
|
75 |
| -Thank you for your interest in contributing to Eliza! |
| 129 | +Thank you for contributing to Eliza and helping build the future of autonomous AI agents! 🎉 |
0 commit comments