stac-utils / stac-utils/stac-fastapi

Improve contributing guide

Open
#433 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

api layer documentation
Dominant language
Python
Stars
324
Forks
126
Avg merge
1d 22h
Merged PRs (30d)
10

Description

Existing guide is here: https://github.com/stac-utils/stac-fastapi/blob/master/CONTRIBUTING.md.

Expectations around reviewing / merging PRs and code quality / standards are not very clear. Better PR and issue templates may help too.

I think that https://github.com/stac-utils/stac-fastapi/issues/432 will help.

Contributor guide

Open the 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.

Research direction

Start by reading CONTRIBUTING.md and issue #432. Identify the unclear expectations around reviewing and merging pull requests and code quality and standards, then assess how improved pull request and issue templates could address them. Done means the contributing guidance and relevant templates clearly describe these expectations.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.