Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Add a readme file and other documentation

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

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Review the repository to determine whether a README or other documentation already exists; no specific file or test is named in the issue. Document project setup, including how a user obtains a proper Google account for satellite images, and consider the work done when those instructions are available to users.

Written by the indexing model from the issue text.

Description

documentation

It would also be useful to have instructions on how to get set up with a proper Google account so that the user can obtain satellite images.

Dominant language
Python
Stars
0
Forks
1
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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 BrainsOnBoard/python-gm-plotting

All issues in BrainsOnBoard/python-gm-plotting

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.