OpenCut-app / OpenCut-app/OpenCut

Docs needed for the project

Open
#10 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
TypeScript
Stars
89.8k
Forks
8.9k
PR merge metrics
No merged PRs in 30d

Description

A guide for getting started with the project to help new developers get started easily.

Should include things lile:

  • Clone project
  • Install dependencies
  • Create database (eg: locally with Docker)
  • Set necessary environment variables
  • And so on...

This should be in a CONTRIBUTING.md file

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the project's existing setup requirements and the proposed local database workflow with Docker before creating CONTRIBUTING.md. Done means the guide covers cloning, dependency installation, database creation, required environment variables, and any other necessary steps for a new developer to get started.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.