devvkit / generators
OSS Scaffold Generator
Generate CONTRIBUTING.md, PR templates, issue templates, SECURITY.md, and Code of Conduct for your open source repo.
Project details
# Contributing to my-project Thanks for taking the time to contribute! We welcome first-time contributors and maintainers alike. ## Getting started 1. Read the README and run the project locally: ```bash npm ci npm run dev ``` 2. Look for issues labeled `good first issue`: they are scoped and newcomer-safe. 3. Comment on the issue you want to work on so maintainers know it is taken. 4. Open a draft PR early (even empty) so everyone sees your progress. ## Branch & commit conventions - Branch names: `fix/description`, `feat/description`, `docs/description` - Commits follow [Conventional Commits](https://www.conventionalcommits.org): - `fix:`: a bug fix - `feat:`: a new capability - `docs:`: documentation only - `refactor:`, `perf:`, `test:`, `build:`, `ci:`, `chore:` - Keep changes small and focused. One issue = one PR. ## Making a pull request 1. Fork the repository and create your branch from `main`. 2. Write tests for your change: CI enforces coverage. 3. Run the full check suite: ```bash npm test npm run lint npm run build ``` 4. Open the PR against `main` and fill out the template completely. 5. A maintainer reviews within 48 hours. Push requested changes as new commits. ## Code of conduct All contributors must follow our Code of Conduct. Be kind, be patient: maintainers and contributors are volunteers. A delightful developer tool for solving real problems. Released under the [MIT License](https://opensource.org/license/mit/).
Ship it right
> Add these files to your repo root: .github/ for PR/issue templates, everything else in ./.
> For MIT License, replace the placeholder text in LICENSE with the full official text before publishing.
> Add CI from day one: .github/workflows/ci.yml running tests, lint, and build.
share this tool
related tools
Generate the complete community file suite for a new open source repository: CONTRIBUTING.md, pull request template, bug and feature issue templates, SECURITY.md, Code of Conduct, and LICENSE: filled with your project details and downloadable individually or as a zip.
- -CONTRIBUTING.md with branch, commit, and PR conventions
- -PULL_REQUEST_TEMPLATE.md and issue templates (YAML)
- -SECURITY.md with reporting and supported versions
- -CODE_OF_CONDUCT.md (Contributor Covenant 2.1)
- -LICENSE with copyright filled from your details
- -Copy per file or download everything as a .zip
- >Setting up a new repository for community contribution
- >Adding missing community files to an existing repo
- >Preparing a project for a hackathon or open source event
- >Standardizing community files across an organization