Skip to content

Latest commit

 

History

History
75 lines (46 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

75 lines (46 loc) · 2.76 KB
Raw

Contributing to Eliza

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.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please report unacceptable behavior.

How Can I Contribute?

Reporting Bugs

  1. Ensure the bug was not already reported by searching on GitHub under Issues.
  2. If you're unable to find an open issue addressing the problem, open a new one. Be sure to include
  • a title and clear description,
  • as much relevant information as possible, and
  • a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  1. Open a new issue with a clear title and detailed description of the suggested enhancement.
  2. Include any relevant examples or mock-ups if applicable.

Pull Requests

  1. Fork the repo and create your branch from main.
    1. The name of the branch should start with the issue number and be descriptive of the changes you are making.
    2. eg. 40--add-test-for-bug-123
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

JavaScript Styleguide

TypeScript Styleguide

Documentation Styleguide

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

  • bug - Issues that are bugs.
  • enhancement - Issues that are feature requests.
  • documentation - Issues or pull requests related to documentation.
  • good first issue - Good for newcomers.

Recognition

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.

Questions?

If you have any questions, please feel free to contact the project maintainers with an issue or in discord.

Thank you for your interest in contributing to Eliza!