repositories
loading repo index
repositories
loading repo index
repository
loading code, commits, and activity
public Clawd ADK gateway launch mirror
stars
latest
clone command
git clone gitlawb://did:key:z6Mkq5mY...iFZ5/my-project-publ...git clone gitlawb://did:key:z6Mkq5mY.../my-project-publ...2fa351d6docs: add automaton and perps launch sources16d ago| #1 | # Contributing to OpenMemory |
| #2 | |
| #3 | We are a team of developers passionate about the future of AI and open-source software. With years of experience in both fields, we believe in the power of community-driven development and are excited to build tools that make AI more accessible and personalized. |
| #4 | |
| #5 | ## Ways to Contribute |
| #6 | |
| #7 | We welcome all forms of contributions: |
| #8 | - Bug reports and feature requests through GitHub Issues |
| #9 | - Documentation improvements |
| #10 | - Code contributions |
| #11 | - Testing and feedback |
| #12 | - Community support and discussions |
| #13 | |
| #14 | ## Development Workflow |
| #15 | |
| #16 | 1. Fork the repository |
| #17 | 2. Create your feature branch (`git checkout -b openmemory/feature/amazing-feature`) |
| #18 | 3. Commit your changes (`git commit -m 'Add some amazing feature'`) |
| #19 | 4. Push to the branch (`git push origin openmemory/feature/amazing-feature`) |
| #20 | 5. Open a Pull Request |
| #21 | |
| #22 | ## Development Setup |
| #23 | |
| #24 | ### Backend Setup |
| #25 | |
| #26 | ```bash |
| #27 | # Copy environment file and edit file to update OPENAI_API_KEY and other secrets |
| #28 | make env |
| #29 | |
| #30 | # Build the containers |
| #31 | make build |
| #32 | |
| #33 | # Start the services |
| #34 | make up |
| #35 | ``` |
| #36 | |
| #37 | ### Frontend Setup |
| #38 | |
| #39 | The frontend is a React application. To start the frontend: |
| #40 | |
| #41 | ```bash |
| #42 | # Install dependencies and start the development server |
| #43 | make ui-dev |
| #44 | ``` |
| #45 | |
| #46 | ### Prerequisites |
| #47 | - Docker and Docker Compose |
| #48 | - Python 3.9+ (for backend development) |
| #49 | - Node.js (for frontend development) |
| #50 | - OpenAI API Key (for LLM interactions) |
| #51 | |
| #52 | ### Getting Started |
| #53 | Follow the setup instructions in the README.md file to set up your development environment. |
| #54 | |
| #55 | ## Code Standards |
| #56 | |
| #57 | We value: |
| #58 | - Clean, well-documented code |
| #59 | - Thoughtful discussions about features and improvements |
| #60 | - Respectful and constructive feedback |
| #61 | - A welcoming environment for all contributors |
| #62 | |
| #63 | ## Pull Request Process |
| #64 | |
| #65 | 1. Ensure your code follows the project's coding standards |
| #66 | 2. Update documentation as needed |
| #67 | 3. Include tests for new features |
| #68 | 4. Make sure all tests pass before submitting |
| #69 | |
| #70 | Join us in building the future of AI memory management! Your contributions help make OpenMemory better for everyone. |
| #71 |