|
| 1 | +# Contributing to Eliza |
| 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. |
| 4 | + |
| 5 | +## Code of Conduct |
| 6 | + |
| 7 | +By participating in this project, you are expected to uphold our Code of Conduct. Please report unacceptable behavior. |
| 8 | + |
| 9 | +## How Can I Contribute? |
| 10 | + |
| 11 | +### Reporting Bugs |
| 12 | + |
| 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 |
| 15 | + |
| 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. |
| 19 | + |
| 20 | +### Suggesting Enhancements |
| 21 | + |
| 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. |
| 24 | + |
| 25 | +### Pull Requests |
| 26 | + |
| 27 | +1. Fork the repo and create your branch from `main`. |
| 28 | + 1. The name of the branch should start with the issue number and be descriptive of the changes you are making. |
| 29 | + 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! |
| 34 | + |
| 35 | +## Styleguides |
| 36 | + |
| 37 | +### Git Commit Messages |
| 38 | + |
| 39 | +- Use the present tense ("Add feature" not "Added feature") |
| 40 | +- Use the imperative mood ("Move cursor to..." not "Moves cursor to...") |
| 41 | +- Limit the first line to 72 characters or less |
| 42 | +- Reference issues and pull requests liberally after the first line |
| 43 | + |
| 44 | +### JavaScript Styleguide |
| 45 | + |
| 46 | +- All JavaScript must adhere to [JavaScript Standard Style](https://standardjs.com/). |
| 47 | + |
| 48 | +### TypeScript Styleguide |
| 49 | + |
| 50 | +- All TypeScript must adhere to [TypeScript Standard Style](https://github.com/standard/ts-standard). |
| 51 | + |
| 52 | +### Documentation Styleguide |
| 53 | + |
| 54 | +- Use [Markdown](https://daringfireball.net/projects/markdown/) for documentation. |
| 55 | + |
| 56 | +## Additional Notes |
| 57 | + |
| 58 | +### Issue and Pull Request Labels |
| 59 | + |
| 60 | +This section lists the labels we use to help us track and manage issues and pull requests. |
| 61 | + |
| 62 | +- `bug` - Issues that are bugs. |
| 63 | +- `enhancement` - Issues that are feature requests. |
| 64 | +- `documentation` - Issues or pull requests related to documentation. |
| 65 | +- `good first issue` - Good for newcomers. |
| 66 | + |
| 67 | +## Recognition |
| 68 | + |
| 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. |
| 70 | + |
| 71 | +## Questions? |
| 72 | + |
| 73 | +If you have any questions, please feel free to contact the project maintainers with an issue or in discord. |
| 74 | + |
| 75 | +Thank you for your interest in contributing to Eliza! |
0 commit comments