Skip to content

docs: add CONTRIBUTING.md#14

Merged
Jiaaqiliu merged 1 commit intoaiming-lab:mainfrom
jecanore:docs/contributing
Mar 17, 2026
Merged

docs: add CONTRIBUTING.md#14
Jiaaqiliu merged 1 commit intoaiming-lab:mainfrom
jecanore:docs/contributing

Conversation

@jecanore
Copy link
Contributor

Problem

No contributor guide exists. New contributors must reverse-engineer the setup process from scattered files and README fragments.

Solution

Add CONTRIBUTING.md covering:

  • Fork, clone, venv, and pip install -e ".[dev]" setup
  • Config conventions (config.arc.yaml vs config.yaml vs example template)
  • Running tests and researchclaw doctor
  • PR guidelines

Test plan

  • Setup steps verified end-to-end on a fresh clone
  • Docs-only change — no code tests needed

Documents the fork-clone-setup workflow including dev extras,
researchclaw init, config conventions, and PR expectations.
Jah-yee pushed a commit to Jah-yee/AutoResearchClaw that referenced this pull request Mar 17, 2026
- Add development setup instructions (fork, clone, venv, pip install)
- Document configuration file conventions
- Include testing and health check commands
- Add PR guidelines and code style notes

Fixes aiming-lab#14
@Jah-yee Jah-yee mentioned this pull request Mar 17, 2026
2 tasks
@Jiaaqiliu Jiaaqiliu merged commit f41f092 into aiming-lab:main Mar 17, 2026
Jiaaqiliu added a commit that referenced this pull request Mar 17, 2026
Merged community PRs:
- PR #12: researchclaw init command and config auto-detection
- PR #14: CONTRIBUTING.md
- PR #17: ssh_remote and colab_drive experiment sandbox backends
- PR #19: native Anthropic Messages API support via adapter pattern

Additional fixes:
- Deduplicate pyproject.toml optional-dependencies section
- Handle OSError in colab drive availability check
- Add test_outputs and local docs to .gitignore
@Jiaaqiliu
Copy link
Collaborator

Hi @jecanore, thanks for adding the CONTRIBUTING.md!

We've merged this PR. The contributing guide is now live on main and will help new contributors get started quickly.

Clean and concise — exactly what the project needed. Appreciate your continued contributions!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants