You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
123
+
124
+
#### Scope
125
+
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.
127
+
90
128
Thank you for contributing to Eliza and helping build the future of autonomous AI agents! 🎉
First off, thank you for considering contributing to Eliza! We welcome contributions from everyone, regardless of experience level.
7
4
8
-
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.
5
+
## Contribution License Agreement
6
+
7
+
By contributing to Eliza, you agree that your contributions will be licensed under the MIT License. This means:
8
+
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.
9
13
10
14
## The OODA Loop: A Framework for Contribution
11
15
@@ -16,83 +20,109 @@ We believe in the power of the OODA Loop - a decision-making framework that emph
16
20
-**Decide**: Choose a course of action based on your analysis. This could be proposing a new feature, fixing a bug, or creating content.
17
21
-**Act**: Execute your decision and share your work with the community.
18
22
19
-
By internalizing the OODA Loop, you can quickly identify areas where you can make a meaningful impact and drive the project forward.
20
-
21
-
---
22
-
23
23
## How to Contribute
24
24
25
25
### For Developers
26
26
27
27
1.**Extend Eliza's Capabilities**
28
-
29
-
- Develop new actions, evaluators, and providers to expand what Eliza agents can do.
30
-
- Improve existing components and modules.
28
+
- Develop new actions, evaluators, and providers
29
+
- Improve existing components and modules
31
30
32
31
2.**Enhance Infrastructure**
32
+
- Review open issues and submit PRs
33
+
- Test and update documentation
34
+
- Optimize performance
35
+
- Improve deployment solutions
36
+
37
+
1. Fork the repo and create your branch from `main`.
38
+
1. The name of the branch should start with the issue number and be descriptive of the changes you are making.
39
+
1. eg. 40--add-test-for-bug-123
40
+
2. If you've added code that should be tested, add tests.
41
+
3. Ensure the test suite passes.
42
+
4. Make sure your code lints.
43
+
5. Issue that pull request!
44
+
45
+
## Styleguides
46
+
47
+
### Git Commit Messages
48
+
49
+
- Use the present tense ("Add feature" not "Added feature")
50
+
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
51
+
- Limit the first line to 72 characters or less
52
+
- Reference issues and pull requests liberally after the first line
33
53
34
-
- Go through open issues, send back a PR if you can improve anything.
35
-
- Test currently documented steps to ensure they're still up to date.
36
-
- Optimize Eliza's database architecture and performance.
37
-
- Contribute to the autonomous trading system and trust engine.
38
-
- Improve deployment and scaling solutions.
54
+
### JavaScript Styleguide
39
55
40
-
3.**Implement Integrations**
41
-
- Build connectors for new platforms and services.
42
-
- Enhance existing integrations with additional features.
56
+
- All JavaScript must adhere to [JavaScript Standard Style](https://standardjs.com/).
43
57
44
-
### For AI Enthusiasts
58
+
### TypeScript Styleguide
45
59
46
-
1.**Fine-tune Models**
60
+
- All TypeScript must adhere to [TypeScript Standard Style](https://github.com/standard/ts-standard).
47
61
48
-
- Experiment with fine-tuning models for specific tasks and domains.
49
-
- Develop best practices for prompt engineering and model selection.
62
+
### Documentation Styleguide
50
63
51
-
2.**Develop Characters**
52
-
- Create compelling character files that showcase Eliza's potential.
53
-
- Curate knowledge bases and datasets for different use cases.
64
+
- Use [Markdown](https://daringfireball.net/projects/markdown/) for documentation.
54
65
55
-
### Non-Technical Contributions
66
+
##Additional Notes
56
67
57
-
1.**Create Content**
68
+
### Issue and Pull Request Labels
69
+
70
+
This section lists the labels we use to help us track and manage issues and pull requests.
71
+
72
+
-`bug` - Issues that are bugs.
73
+
-`enhancement` - Issues that are feature requests.
74
+
-`documentation` - Issues or pull requests related to documentation.
75
+
-`good first issue` - Good for newcomers.
76
+
77
+
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)
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.
58
93
59
-
- Make memes, stickers, emojis, and clips of AI agents that are deployed.
60
-
- Write tutorials, guides, and blog posts to help others learn about Eliza.
61
-
- Produce videos showcasing Eliza's capabilities and real-world applications.
94
+
### Code of Conduct
62
95
63
-
2.**Engage the Community**
96
+
#### Our Pledge
64
97
65
-
- Participate in discussions on Discord, Twitter, and other platforms.
66
-
- Help answer questions and provide support to other community members.
67
-
- Organize events, workshops, and hackathons to bring people together.
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.
68
99
69
-
3.**Spread the Word**
70
-
- Share the Eliza project and help attract new contributors.
71
-
- Participate in one of our upcoming demo days, show and tell your project.
100
+
#### Our Standards
72
101
73
-
---
102
+
Examples of behavior that contributes to creating a positive environment include:
74
103
75
-
### Tips for Efficient Contribution
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
76
109
77
-
- Use tools like OBS and Whisper to record and transcribe your work sessions. This allows you to easily document your process and share insights with the community.
78
-
- Leverage AI assistants to help with tasks like code generation, document summarization, and content creation.
79
-
- Collaborate with other community members to divide and conquer larger initiatives.
110
+
Examples of unacceptable behavior include:
80
111
81
-
## Recognition and Rewards
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
82
117
83
-
We believe in recognizing and rewarding contributors who go above and beyond to drive the project forward. Stand-out contributions may be eligible for:
118
+
#### Our Responsibilities
84
119
85
-
- Grants from the ai16z Creator Fund
86
-
- Featuring your project across various channels
87
-
- Opportunities to shape the direction of the project
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.
88
121
89
-
Note: we're still finalizing details on the creator/dev fund that seeks to retroactively reward valued contributions to the ecosystem.
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.
90
123
91
-
##Getting Started
124
+
#### Scope
92
125
93
-
1. Join the [Eliza Discord](https://discord.gg/ai16z) and make a short introduction.
94
-
2. Explore the [documentation](/docs/intro) to understand the project's architecture and capabilities.
95
-
3. Check out the [open issues](https://github.com/ai16z/eliza/issues) on GitHub to find ways to contribute.
96
-
4. Share your ideas and initiatives with the community - we're excited to see what you'll build!
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.
97
127
98
-
Lets push the boundaries of what's possible with autonomous AI agents. Welcome aboard!
128
+
Thank you for contributing to Eliza and helping build the future of autonomous AI agents! 🎉
0 commit comments