CONTRIBUTE.md

How to contribute

1. copy the template below
2. replace all REPLACE_WITH_... placeholders with the actual values

Checklist for replacing placeholders:

• Replace REPLACE_WITH_LIB_URL with library main url. Example: https://ariakit.org
• Replace REPLACE_WITH_LIB_NAME with library name. Example: AriaKit
• Replace REPLACE_WITH_LIB_DESCRIPTION with library description. Example: AriaKit is a collection of accessible React components...
• Replace REPLACE_WITH_LIB_GH_USER with library github user (github.com/<user>). Example: ariakit
• Replace REPLACE_WITH_LIB_GH_REPO_NAME with library github repo name (github.com/<user>/<repo-name>). Example: ariakit
• Replace REPLACE_WITH_LIB_GH_REPO_URL with library github repo url. Example: `https://github.com/ariakit/ariakit
• Replace REPLACE_WITH_NPM_PACKAGE_NAME with library npm package name (same as used to install, npm install @ariakit/react). Example: %40ariakit%2Freact (@ariakit/react URL encoded)

---

Templates

Compact template:

REPLACE_WITH_LIB_NAME - REPLACE_WITH_LIB_DESCRIPTION

With Stats template:

REPLACE_WITH_LIB_NAME - REPLACE_WITH_LIB_DESCRIPTION

---

Notes:

Shields.io badges docs:

• github stars - https://shields.io/badges/git-hub-repo-stars
• commit activity - https://shields.io/badges/git-hub-commit-activity
• created at - https://shields.io/badges/github-created-at
• npm downloads - https://shields.io/badges/npm-downloads
• npm bundle size - https://shields.io/badges/npm-bundle-size
• github discussions - https://shields.io/badges/git-hub-discussions
• github issues - https://shields.io/badges/git-hub-issues-or-pull-requests
• npm version https://shields.io/badges/npm-version
• language - https://shields.io/badges/git-hub-top-language