Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (44 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

63 lines (44 loc) · 1.56 KB

Contributing to bragdoc

Thanks for your interest in contributing! Here's how to get started.

Local Development

git clone https://github.com/luissena/bragdoc.git
cd bragdoc
npm install
npm run dev

The app runs at http://localhost:3000.

Available Scripts

Command Description
npm run dev Start dev server
npm run build Production build
npm run lint Run ESLint

Making Changes

  1. Fork the repo and create a branch from main
  2. Use a descriptive branch name: feat/quick-capture-tags, fix/heatmap-off-by-one
  3. Make your changes
  4. Run npm run lint and npm run build before submitting
  5. Open a pull request against main

Commit Conventions

This project uses Conventional Commits:

Prefix Use
feat: New feature
fix: Bug fix
docs: Documentation only
chore: Build, tooling, dependencies
refactor: Code change that doesn't fix a bug or add a feature
test: Adding or updating tests

Example: feat: add tag autocomplete to quick capture

Pull Requests

  • Keep PRs focused — one feature or fix per PR
  • Fill out the PR template
  • Link any related issues

Reporting Bugs

Open an issue using the Bug Report template. Include:

  • Steps to reproduce
  • Expected vs actual behavior
  • Browser and OS

Requesting Features

Open an issue using the Feature Request template. Describe the problem you're trying to solve and any alternatives you've considered.