Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

70 lines (45 loc) · 1.76 KB
Raw

Contributing to Devon

Thank you for your interest in contributing to Devon! We welcome contributions from the community to help make Devon a powerful and widely-accessible AI assistant for software developers.

Contribution Form

If you would like to contribute to the project, please fill out this form:

Contribution Form

Contribution Workflow

Here's an overview of the contribution workflow:

  1. Fork the Devon repository to your own GitHub account
  2. Clone your fork locally
  3. Create a new branch for your changes (e.g. git checkout -b my-feature-branch)
  4. Make your changes and commit them with descriptive messages
  5. Push your changes to your fork on GitHub
  6. Open a pull request from your fork to the main Devon repository

Testing Locally

Setup

Run the following commands in your terminal:

chmod u+x build.sh
./build.sh

export DEVON_TELEMETRY_DISABLED=true

Running the terminal UI

Either run:

devon

Or

cd devon-tui
npm run build && node dist/cli.js

Coding Conventions

Please follow these coding conventions when contributing to Devon:

  • Use 4 spaces for indentation (no tabs)
  • Follow PEP 8 style guidelines
  • Include docstrings for all public modules, functions, classes, and methods
  • Use descriptive variable and function names

Pull Requests

When you open a pull request, please include:

  • A clear and descriptive title
  • A description of your changes and why they're needed
  • Steps to test your changes
  • Screenshots or animated GIFs if applicable

A maintainer will review your pull request and may request changes before merging it.

Thank you again for contributing to Devon! We appreciate your help in making this project as useful and robust as possible.