Skip to content

Add first contribution guide #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
afurm merged 1 commit into from
May 8, 2026
Merged

Add first contribution guide #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,29 @@ and easy to review.
4. Small product improvements that preserve the local-first workflow.
5. Documentation and developer experience.

## First Contribution

Start with a small, testable issue from
[`good first issue`](https://github.com/afurm/draftmora/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22)
or
[`help wanted`](https://github.com/afurm/draftmora/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22help%20wanted%22).
If the issue is open and unassigned, leave a short comment saying what you plan
to change before you start.

Use this local loop:

1. Fork or clone the repository and create a focused branch.
2. Run `npm install`.
3. Run `npm run dev` and open `http://localhost:5173`.
4. Make one logical change tied to the issue.
5. Run the relevant checks from the PR checklist below.
6. Open a PR that links the issue and describes the verification you performed.

Keep local state out of the branch. Do not commit `.env`, SQLite databases,
`USER.md`, `MEMORY.md`, build output, dependency folders, logs, or personal
demo data. For UI changes, attach a screenshot or short recording so reviewers
can see the behavior without reproducing every step.

## Development Setup

```bash
Expand Down