review developer setup doc

Open Beginner friendly
#2,996 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

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

Research direction

Read docs/development.md end to end, starting with the "Getting access" intro that the diff shows, and cross-check it against the Developer Setup wiki page it links. The one-line diff adding DigitalOcean is the concrete first edit; the wider task is to follow the whole doc on a fresh machine and note anything missing or wrong. Done means the intro matches the wiki and any setup steps that fail have been corrected or filed.

Written by the indexing model from the issue text.

Description

Follow docs/development.md on a fresh machine and fix anything that's missing or wrong.

Suggested edit: the intro lists GitHub and 1Password for access, but the Developer Setup wiki page also lists DigitalOcean.

-Getting access (GitHub, 1Password) and optional tools are on the
+Getting access (GitHub, DigitalOcean, 1Password) and optional tools are on the
Dominant language
Python
Stars
2
Forks
0
Avg merge
13h 8m
Merged PRs (30d)
138

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

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.

More from NYCPlanning/data-engineering

All issues in NYCPlanning/data-engineering

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.