Contributing
Hey! Thanks for being interested in contributing to Clonecord. Whether it's a bug fix, a new feature, or just improving documentation — every contribution matters and is genuinely appreciated.
-
Fork and clone the repository:
git clone https://github.com/your-username/Clonecord.git cd Clonecord -
Set up the TypeScript config (gitignored because it breaks Vencord's build):
cp tsconfig.template.json tsconfig.json
-
Install dependencies:
npm install
-
Create a branch:
git checkout -b feature/your-feature-name
You're ready to go!
The stubs/ directory provides type definitions for Vencord's internal APIs, so you get full autocompletion without the full Vencord source tree.
| Command | What it does |
|---|---|
npm run typecheck |
Type-check without emitting |
npm test |
Run all tests |
npm run test:watch |
Run tests in watch mode |
npm run lint |
Check for lint errors |
npm run lint:fix |
Auto-fix lint errors |
npm run format |
Auto-format with Prettier |
npm run format:check |
Check formatting |
npm run check |
Run everything (typecheck + lint + format + tests) |
- Clone this repo into
path/to/Vencord/src/userplugins/Clonecord - Run
pnpm buildin the Vencord directory - Run
pnpm injectin the Vencord directory
Important: Do NOT commit
tsconfig.json— it overrides Vencord's module resolution and breakspnpm build.
- Keep changes focused and minimal
- Follow the existing code style
- Test your changes before submitting
- Write clear commit messages
- One feature or fix per pull request
- Ensure
npm run checkpasses (typecheck + lint + format + tests) - Test your changes in Discord
- Update documentation if needed
- Submit your pull request with a clear description of what changed and why
Use the Issue Templates when reporting bugs or requesting features.
This project follows the Contributor Covenant Code of Conduct. By participating, you agree to uphold it.
Thanks for helping make Clonecord better. Seriously.
