Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

46 lines (34 loc) · 1.6 KB

Contributing to Autogenesis

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to Autogenesis. These are mostly guidelines, not rules. Use your best judgment and feel free to propose changes to this document in a pull request.

🛠️ How to Contribute

1. Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • 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 well as as much relevant information as possible.

2. Suggesting Enhancements

  • Open a new issue with the enhancement label.
  • Explain why this enhancement would be useful to most Autogenesis users.

3. Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

🧪 Development Setup

# Backend
cd backend
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

# Frontend
cd frontend
npm install
npm run dev

📐 Style Guide

  • Python: Follow PEP 8.
  • TypeScript: Use Prettier with default settings.
  • Commits: Use clear, present-tense commit messages (e.g., "Add feature" not "Added feature").

Thank you for being part of the future of autonomous coding! 🧬