Skip to content

contributing.md

Latest commit

 

History

History
41 lines (28 loc) · 1.47 KB

contributing.md

File metadata and controls

41 lines (28 loc) · 1.47 KB
Raw

Contributing to Bruno API Docs

Thanks for your interest. This repo holds the Bruno API Docs renderer: the interactive API documentation site and embedded Bruno Playground that Bruno generates from a collection. See the README for what the project is and where it's headed.

Prerequisites

  • Node.js v22.11.0 (see .nvmrc). With nvm: nvm use.
  • npm (ships with Node).

Setup

git clone https://github.com/usebruno/bruno-api-docs.git
cd bruno-api-docs
npm install

Development

Run these from packages/bruno-api-docs:

Task Command
Dev server npm run dev
Unit tests npm run test:run (watch: npm test)
E2E tests npm run test:e2e
Lint npm run lint
Build npm run build (CDN bundle: npm run build:standalone)

Making changes

  1. Open or comment on an issue first for anything beyond a small fix.
  2. Create a branch from main.
  3. Make your change and add or update tests. Run npm run lint and npm run test:run before pushing; run npm run test:e2e when UI behavior changed.
  4. Open a pull request against main describing the change and linking the issue.

Continuous integration runs the end-to-end tests on pull requests via GitHub Actions.

Reporting issues

File issues on GitHub. For bugs, include the smallest collection that reproduces the problem and what you expected to happen.