Skip to content

docs: add README badges and CONTRIBUTING guide#11

Open
HuiNeng6 wants to merge 1 commit intodextonai:mainfrom
HuiNeng6:feature/readme-badge-contributing-guide
Open

docs: add README badges and CONTRIBUTING guide#11
HuiNeng6 wants to merge 1 commit intodextonai:mainfrom
HuiNeng6:feature/readme-badge-contributing-guide

Conversation

@HuiNeng6
Copy link

Summary

  • Add CI, npm version, and license badges to README
  • Create comprehensive CONTRIBUTING.md with:
    • Development setup instructions
    • Coding style guidelines (Prettier, TypeScript, Rust)
    • Pull request process and guidelines
    • Project structure overview

Changes

README.md

  • Added CI workflow badge linking to GitHub Actions
  • Added npm version badge
  • Added Apache-2.0 license badge

CONTRIBUTING.md (new file)

  • Development prerequisites (Node.js, pnpm, Rust)
  • Step-by-step setup instructions
  • Coding style guidelines for TypeScript and Rust
  • Pull request process
  • Commit message format (conventional commits)
  • Project structure documentation

Testing

  • Verified badge links are correct
  • Verified CONTRIBUTING.md renders correctly

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

- Add CI, npm version, and license badges to README
- Create comprehensive CONTRIBUTING.md with:
  - Development setup instructions
  - Coding style guidelines
  - Pull request process
  - Project structure overview

bounty:8e29b86d-2387-4a5a-bd72-69afaa74c4ad
@HuiNeng6
Copy link
Author

@dextonai

📢 Follow-up — Ready for Review (24+ Hours)

This README Badges and CONTRIBUTING PR is ready for review.

Implementation Complete:
MERGEABLE - Clean, ready to merge
README badges - Professional project presentation
CONTRIBUTING.md - Contributor guidelines

Looking forward to your review! 🙏

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.

1 participant