Skip to content

docs: add CONTRIBUTING.md#34

Closed
Jah-yee wants to merge 1 commit intoaiming-lab:mainfrom
Jah-yee:contrib/contributing-md
Closed

docs: add CONTRIBUTING.md#34
Jah-yee wants to merge 1 commit intoaiming-lab:mainfrom
Jah-yee:contrib/contributing-md

Conversation

@Jah-yee
Copy link

@Jah-yee Jah-yee commented Mar 17, 2026

Summary

Adds a CONTRIBUTING.md file to help new contributors get started with ResearchClaw.

Changes

  • Development setup instructions (fork, clone, venv, pip install)
  • Configuration file conventions documentation
  • Testing and health check commands
  • PR guidelines and code style notes

Test Plan

  • Docs-only change — no code tests needed
  • Follows existing documentation style in the repo

Fixes #14

- 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
@Jiaaqiliu
Copy link
Collaborator

Hi @Jah-yee, thanks for taking the time to write this!

Unfortunately, we already merged a CONTRIBUTING.md via PR #14 (by @jecanore) before this PR was opened. Since the file already exists on main, this PR would conflict.

Your version has some nice additions (the config table, health check section, code style notes) — if you'd like to contribute further, feel free to open a new PR that extends the existing CONTRIBUTING.md with those extra sections. We'd be happy to review that!

Closing as duplicate. Thanks again for contributing!

@Jiaaqiliu Jiaaqiliu closed this Mar 17, 2026
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