Skip to content

Commit

Permalink
prettier
Browse files Browse the repository at this point in the history
  • Loading branch information
ponderingdemocritus committed Nov 22, 2024
1 parent 421fe0b commit 9e9836b
Show file tree
Hide file tree
Showing 7 changed files with 144 additions and 140 deletions.
65 changes: 33 additions & 32 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,32 +15,34 @@ By contributing to Eliza, you agree that your contributions will be licensed und

We believe in the power of the OODA Loop - a decision-making framework that emphasizes speed and adaptability. OODA stands for:

- **Observe**: Gather information and insights about the project, the community, and the broader AI ecosystem.
- **Orient**: Analyze your observations to identify opportunities for contribution and improvement.
- **Decide**: Choose a course of action based on your analysis. This could be proposing a new feature, fixing a bug, or creating content.
- **Act**: Execute your decision and share your work with the community.
- **Observe**: Gather information and insights about the project, the community, and the broader AI ecosystem.
- **Orient**: Analyze your observations to identify opportunities for contribution and improvement.
- **Decide**: Choose a course of action based on your analysis. This could be proposing a new feature, fixing a bug, or creating content.
- **Act**: Execute your decision and share your work with the community.

## How to Contribute

### For Developers

1. **Extend Eliza's Capabilities**
- Develop new actions, evaluators, and providers
- Improve existing components and modules

- Develop new actions, evaluators, and providers
- Improve existing components and modules

2. **Enhance Infrastructure**
- Review open issues and submit PRs
- Test and update documentation
- Optimize performance
- Improve deployment solutions

1. Fork the repo and create your branch from `main`.
- Review open issues and submit PRs
- Test and update documentation
- Optimize performance
- Improve deployment solutions

3. 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.
1. 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!
4. If you've added code that should be tested, add tests.
5. Ensure the test suite passes.
6. Make sure your code lints.
7. Issue that pull request!

## Styleguides

Expand Down Expand Up @@ -74,18 +76,17 @@ This section lists the labels we use to help us track and manage issues and pull
- `documentation` - Issues or pull requests related to documentation.
- `good first issue` - Good for newcomers.


## Getting Help

- Join [Discord](https://discord.gg/ai16z)
- Check [FAQ](docs/community/faq.md)
- Create GitHub issues
- Join [Discord](https://discord.gg/ai16z)
- Check [FAQ](docs/community/faq.md)
- Create GitHub issues

## Additional Resources

- [Local Development Guide](docs/guides/local-development.md)
- [Configuration Guide](docs/guides/configuration.md)
- [API Documentation](docs/api)
- [Local Development Guide](docs/guides/local-development.md)
- [Configuration Guide](docs/guides/configuration.md)
- [API Documentation](docs/api)

## Contributor Guide

Expand All @@ -101,19 +102,19 @@ In the interest of fostering an open and welcoming environment, we as contributo

Examples of behavior that contributes to creating a positive environment include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior include:

- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

#### Our Responsibilities

Expand Down
3 changes: 3 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Eliza - Multi-agent simulation framework

# https://github.com/ai16z/eliza

# Visit https://eliza.builders for support

# dev branch

<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/community/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ It is imperative to run all existing tests (`pnpm test`) before creating a PR to

## Branching Strategy

All new features and bug fixes must target the `main` branch, except when they are specific to a previously released version. In such scenarios, the bug fix PR should target the respective release branch. If necessary, changes will be backported from the `main` branch to a release branch, excluding any modifications that involve consensus-breaking features or API changes.
All new features and bug fixes must target the `main` branch, except when they are specific to a previously released version. In such scenarios, the bug fix PR should target the respective release branch. If necessary, changes will be backported from the `main` branch to a release branch, excluding any modifications that involve consensus-breaking features or API changes.
21 changes: 17 additions & 4 deletions docs/docs/community/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
First off, thank you for considering contributing to Eliza! We welcome contributions from everyone, regardless of experience level. 🎉

## Table of Contents

- [Contribution License Agreement](#contribution-license-agreement)
- [Code of Conduct](#code-of-conduct)
- [OODA Loop Framework](#the-ooda-loop-a-framework-for-contribution)
Expand Down Expand Up @@ -30,13 +31,15 @@ We pledge to make participation in our project a harassment-free experience for
### Our Standards

Positive behavior includes:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards others

Unacceptable behavior includes:

- Harassment of any kind
- Discriminatory jokes and language
- Publishing others' private information
Expand All @@ -56,18 +59,19 @@ We follow the OODA Loop for decision-making:
### For Developers

1. **Development Process**

```bash
# Fork and clone
git clone https://github.com/yourusername/eliza.git
cd eliza

# Create branch (include issue number)
git checkout -b 123-add-new-feature

# Make changes, test, and commit
npm test
git commit -m "feat: add new feature"

# Push and create PR
git push origin 123-add-new-feature
```
Expand All @@ -82,43 +86,52 @@ We follow the OODA Loop for decision-making:
## Pull Request Guidelines

### PR Title Format

```
feat|fix|docs|style|refactor|test|chore: title
```

### PR Template

```markdown
# Relates to:

[Link to issue]

# Background

- What does this PR do?
- What kind of change is this?

# Testing

- How to test the changes
- Screenshots (if UI changes)

# Documentation

- Required documentation changes
```

## Styleguides

### Git Commit Messages

- Use present tense ("Add feature" not "Added feature")
- Use imperative mood ("Move cursor" not "Moves cursor")
- Limit first line to 72 characters
- Reference issues after first line

### Code Style

- JavaScript: Follow [JavaScript Standard Style](https://standardjs.com/)
- TypeScript: Follow [TypeScript Standard Style](https://github.com/standard/ts-standard)
- Documentation: Use [Markdown](https://daringfireball.net/projects/markdown/)

## Recognition and Rewards

Contributors can earn:

- "Github - Contributors" role on Discord
- Direct communication with a16z devs
- Recognition for outstanding contributions
Expand All @@ -132,4 +145,4 @@ Contributors can earn:

---

Thank you for contributing to Eliza and helping build the future of autonomous AI agents! 🚀
Thank you for contributing to Eliza and helping build the future of autonomous AI agents! 🚀
60 changes: 32 additions & 28 deletions packages/core/src/tests/videoGeneration.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,36 +26,40 @@ const mockVideoGenerationPlugin = {
const apiKey = runtime.getSetting("LUMA_API_KEY");
return !!apiKey;
}),
handler: vi.fn().mockImplementation(async (runtime, message, state, options, callback) => {
// Initial response
callback({
text: "I'll generate a video based on your prompt",
});

// Check if there's an API error
const fetchResponse = await global.fetch();
if (!fetchResponse.ok) {
callback({
text: "Video generation failed: API Error",
error: true,
});
return;
}

// Final response with video
callback(
{
text: "Here's your generated video!",
attachments: [
handler: vi
.fn()
.mockImplementation(
async (runtime, message, state, options, callback) => {
// Initial response
callback({
text: "I'll generate a video based on your prompt",
});

// Check if there's an API error
const fetchResponse = await global.fetch();
if (!fetchResponse.ok) {
callback({
text: "Video generation failed: API Error",
error: true,
});
return;
}

// Final response with video
callback(
{
source: "videoGeneration",
url: "https://example.com/video.mp4",
text: "Here's your generated video!",
attachments: [
{
source: "videoGeneration",
url: "https://example.com/video.mp4",
},
],
},
],
},
["generated_video_123.mp4"]
);
}),
["generated_video_123.mp4"]
);
}
),
},
],
};
Expand Down
1 change: 0 additions & 1 deletion packages/create-eliza-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ deno run -A npm:create-eliza-app@latest path

<!-- /automd -->


## Command Line Arguments

- `--name`: Name of the template to use (default: "eliza")
Expand Down
Loading

0 comments on commit 9e9836b

Please sign in to comment.