mirrors/archon
1
0
Fork 0
mirror of https://github.com/coleam00/Archon.git synced 2025-12-24 02:39:17 -05:00
Code Issues Packages Projects Releases Wiki Activity

Important updates to CONTRIBUTING.md and README

Browse Source
This commit is contained in:
Cole Medin
2025-08-21 11:44:32 -05:00
parent 16bde51403
commit 6f7c08eeb7
2 changed files with 33 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
CONTRIBUTING.md
View File

@@ -81,6 +81,37 @@ After forking the repository, you'll need to:
- Open http://localhost:3737
- Go to Settings → Add your OpenAI API key
## 👑 Important Standards for Contributing
There are a few very important rules that we ask you follow when contributing to Archon.
Some things like testing are covered more later in this document but there are a few
very important specifics to call out here.
**1. Check the list of PRs** to make sure you aren't about to fix or implement something that's already been done! Also be sure to check the [Archon Kanban board](https://github.com/users/coleam00/projects/1) where the maintainers are manage issues/features.
**2. Try to keep the changes to less than 2,000 lines of code.** The more granular the PR, the better! If your changes must be larger, it's very important to go into extra detail in your PR and explain why the larger changes are necessary.
**3. Keep PRs to a single feature.** Please split any that implement multiple features into multiple PRs.
**4. Even within individual features, aim for simplicity** - concise implementations are always the best!
**5. If your code changes touch the crawling functionality in any way**, please test crawling an llms.txt, a sitemap.xml, and a normal URL with recursive crawling. Here are smaller examples you can use for testing:
- llms.txt: https://docs.mem0.ai/llms-full.txt
- sitemap.xml: https://mem0.ai/sitemap.xml
- Normal URL: https://docs.anthropic.com/en/docs/claude-code/overview
Make sure the crawling completes end to end, the code examples exist, and the Archon MCP can be used to successfully search through the documentation.
**6. If your code changes touch the project/task management in any way**, please test all the CRUD (Create, Read, Update, Delete) operations on both projects and tasks. Generally you will:
- Create a new project
- Create a couple of tasks
- Move the tasks around the kanban board
- Edit descriptions
Test these things using both the UI and the MCP server. This process will be similar if your code changes touch the docs part of Archon too.
**7. If your code changes touch the MCP server instructions or anything else more high level** that could affect how AI coding assistants use the Archon MCP, please retest by creating a simple project from scratch that leverages Archon for RAG, task management, etc.
## 🔄 Contribution Process
### 1. Choose Your Contribution

3
README.md
View File

@@ -34,7 +34,8 @@ This new vision for Archon replaces the old one (the agenteer). Archon used to b
- **[GitHub Discussions](https://github.com/coleam00/Archon/discussions)** - Join the conversation and share ideas about Archon
- **[Contributing Guide](CONTRIBUTING.md)** - How to get involved and contribute to Archon
- **[Introduction Video](https://youtu.be/8pRc_s2VQIo)** - Getting Started Guide and Vision for Archon
- **[Introduction Video](https://youtu.be/8pRc_s2VQIo)** - Getting started guide and vision for Archon
- **[Archon Kanban Board](https://github.com/users/coleam00/projects/1)** - Where maintainers are managing issues/features
- **[Dynamous AI Mastery](https://dynamous.ai)** - The birthplace of Archon - come join a vibrant community of other early AI adopters all helping each other transform their careers and businesses!
## Quick Start