We use cookies to understand how the site is used and to display ads. Analytics and advertising only run after you accept. You can change your choice anytime. Privacy policy

Skip to content
devvkit

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.md · 46 lines
# 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

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.

>[x]Features
  • -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
>>Use Cases
  • >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

Frequently Asked Questions

>What files does the scaffold generator produce??
CONTRIBUTING.md, PULL_REQUEST_TEMPLATE.md, bug and feature issue templates (GitHub YAML format), SECURITY.md, CODE_OF_CONDUCT.md, and a LICENSE file: everything a new open source repo needs to attract and guide contributors.
>Where should these files go??
CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md, and LICENSE go in the repository root. The PR template goes in .github/PULL_REQUEST_TEMPLATE.md (or root as PULL_REQUEST_TEMPLATE.md) and issue templates in .github/ISSUE_TEMPLATE/. GitHub picks them up automatically.
>Do I need a license file??
Yes: without a license, your project is all-rights-reserved by default and others cannot legally use it. The tool fills in the copyright line, but for non-MIT licenses you should paste the full official license text before publishing.
>Can I download everything at once??
Yes, the "All as .zip" button bundles every generated file into a single oss-scaffold.zip using JSZip: no data leaves your browser.