Skip to content

docs: add CONTRIBUTING.md and CI/npm/license badges to README#31

Open
DrGalio wants to merge 1 commit intodextonai:mainfrom
DrGalio:docs/add-contributing-and-badges
Open

docs: add CONTRIBUTING.md and CI/npm/license badges to README#31
DrGalio wants to merge 1 commit intodextonai:mainfrom
DrGalio:docs/add-contributing-and-badges

Conversation

@DrGalio
Copy link
Copy Markdown

@DrGalio DrGalio commented Mar 26, 2026

Summary

Fixes #1

This PR adds a contribution guide and status badges as requested in the bounty.

Changes

  1. CONTRIBUTING.md — New file covering:

    • Prerequisites (Node.js, pnpm, optional Rust)
    • Dev environment setup (fork, clone, install, verify)
    • Project structure overview
    • Coding style guidelines (formatting, naming, imports)
    • Testing instructions
    • Branch/commit conventions (Conventional Commits)
    • PR submission process
    • How to add CLI commands
    • Issue reporting and security policy
  2. README.md — Added badges and contributing link:

    • CI status badge (linked to GitHub Actions)
    • npm version badge
    • License badge
    • Contributing section linking to CONTRIBUTING.md

Bounty

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

- Add CONTRIBUTING.md with dev setup, coding style, testing, and PR guidelines
- Add CI status, npm version, and license badges to README header
- Add Contributing section linking to CONTRIBUTING.md

Refs: 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