@@ -15,30 +15,35 @@ By contributing to Eliza, you agree that your contributions will be licensed und
15
15
16
16
We believe in the power of the OODA Loop - a decision-making framework that emphasizes speed and adaptability. OODA stands for:
17
17
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.
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.
22
22
23
23
## How to Contribute
24
24
25
25
### For Developers
26
26
27
27
1 . ** Extend Eliza's Capabilities**
28
28
29
- - Develop new actions, evaluators, and providers
30
- - Improve existing components and modules
29
+ - Develop new actions, evaluators, and providers
30
+ - Improve existing components and modules
31
31
32
32
2 . ** Enhance Infrastructure**
33
33
34
- - Review open issues and submit PRs
35
- - Test and update documentation
36
- - Optimize performance
37
- - Improve deployment solutions
34
+ - Review open issues and submit PRs
35
+ - Test and update documentation
36
+ - Optimize performance
37
+ - Improve deployment solutions
38
38
39
39
3 . Fork the repo and create your branch from ` main ` .
40
+ <<<<<<< Updated upstream
40
41
1. The name of the branch should start with the issue number and be descriptive of the changes you are making.
41
42
2. Example: 9999--add-test-for-bug-123
43
+ =======
44
+ 1 . The name of the branch should start with the issue number and be descriptive of the changes you are making.
45
+ 1 . eg. 40--add-test-for-bug-123
46
+ >>>>>>> Stashed changes
42
47
4 . If you've added code that should be tested, add tests.
43
48
5 . Ensure the test suite passes.
44
49
6 . Make sure your code lints.
@@ -48,45 +53,45 @@ We believe in the power of the OODA Loop - a decision-making framework that emph
48
53
49
54
### Git Commit Messages
50
55
51
- - Use the present tense ("Add feature" not "Added feature")
52
- - Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
53
- - Limit the first line to 72 characters or less
54
- - Reference issues and pull requests liberally after the first line
56
+ - Use the present tense ("Add feature" not "Added feature")
57
+ - Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
58
+ - Limit the first line to 72 characters or less
59
+ - Reference issues and pull requests liberally after the first line
55
60
56
61
### JavaScript Styleguide
57
62
58
- - All JavaScript must adhere to [ JavaScript Standard Style] ( https://standardjs.com/ ) .
63
+ - All JavaScript must adhere to [ JavaScript Standard Style] ( https://standardjs.com/ ) .
59
64
60
65
### TypeScript Styleguide
61
66
62
- - All TypeScript must adhere to [ TypeScript Standard Style] ( https://github.com/standard/ts-standard ) .
67
+ - All TypeScript must adhere to [ TypeScript Standard Style] ( https://github.com/standard/ts-standard ) .
63
68
64
69
### Documentation Styleguide
65
70
66
- - Use [ Markdown] ( https://daringfireball.net/projects/markdown/ ) for documentation.
71
+ - Use [ Markdown] ( https://daringfireball.net/projects/markdown/ ) for documentation.
67
72
68
73
## Additional Notes
69
74
70
75
### Issue and Pull Request Labels
71
76
72
77
This section lists the labels we use to help us track and manage issues and pull requests.
73
78
74
- - ` bug ` - Issues that are bugs.
75
- - ` enhancement ` - Issues that are feature requests.
76
- - ` documentation ` - Issues or pull requests related to documentation.
77
- - ` good first issue ` - Good for newcomers.
79
+ - ` bug ` - Issues that are bugs.
80
+ - ` enhancement ` - Issues that are feature requests.
81
+ - ` documentation ` - Issues or pull requests related to documentation.
82
+ - ` good first issue ` - Good for newcomers.
78
83
79
84
## Getting Help
80
85
81
- - Join [ Discord] ( https://discord.gg/ai16z )
82
- - Check [ FAQ] ( docs/community/faq.md )
83
- - Create GitHub issues
86
+ - Join [ Discord] ( https://discord.gg/ai16z )
87
+ - Check [ FAQ] ( docs/community/faq.md )
88
+ - Create GitHub issues
84
89
85
90
## Additional Resources
86
91
87
- - [ Local Development Guide] ( docs/guides/local-development.md )
88
- - [ Configuration Guide] ( docs/guides/configuration.md )
89
- - [ API Documentation] ( docs/api )
92
+ - [ Local Development Guide] ( docs/guides/local-development.md )
93
+ - [ Configuration Guide] ( docs/guides/configuration.md )
94
+ - [ API Documentation] ( docs/api )
90
95
91
96
## Contributor Guide
92
97
@@ -102,19 +107,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
102
107
103
108
Examples of behavior that contributes to creating a positive environment include:
104
109
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
+ - Using welcoming and inclusive language
111
+ - Being respectful of differing viewpoints and experiences
112
+ - Gracefully accepting constructive criticism
113
+ - Focusing on what is best for the community
114
+ - Showing empathy towards other community members
110
115
111
116
Examples of unacceptable behavior include:
112
117
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
+ - The use of sexualized language or imagery and unwelcome sexual attention or advances
119
+ - Trolling, insulting/derogatory comments, and personal or political attacks
120
+ - Public or private harassment
121
+ - Publishing others' private information without explicit permission
122
+ - Other conduct which could reasonably be considered inappropriate in a professional setting
118
123
119
124
#### Our Responsibilities
120
125
0 commit comments