Skip to content

docs: add CONTRIBUTING.md and CI badge to README (Fixes #1)#73

Open
zeroknowledge0x wants to merge 1 commit into
dextonai:mainfrom
zeroknowledge0x:docs/contributing-guide
Open

docs: add CONTRIBUTING.md and CI badge to README (Fixes #1)#73
zeroknowledge0x wants to merge 1 commit into
dextonai:mainfrom
zeroknowledge0x:docs/contributing-guide

Conversation

@zeroknowledge0x
Copy link
Copy Markdown

Summary

Adds a comprehensive contribution guide and CI status badge to the README, as requested in issue #1.

Changes

  • Created CONTRIBUTING.md with:
    • Development setup instructions (Node.js, pnpm, Rust prerequisites)
    • Project structure overview
    • Coding style guidelines for TypeScript and Rust
    • Git commit message conventions (conventional commits)
    • Pull request submission workflow
    • Bug reporting guidelines
    • Feature request guidelines
    • Code review process
  • Added CI status badge to README.md

Acceptance Criteria

  • CONTRIBUTING.md includes dev environment setup
  • CONTRIBUTING.md includes coding style guidelines
  • CONTRIBUTING.md includes PR submission instructions
  • README badge shows build status

bounty:8e29b86d-2387-4a5a-bd72-69afaa74c4ad

Closes #1

- Add comprehensive contribution guide with setup instructions
- Include project structure overview
- Add coding style guidelines for TypeScript and Rust
- Add commit message conventions
- Add CI status badge to README

Closes dextonai#1
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.

Add a README badge and contribution guide to agent-browser

1 participant