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

[CHORE] Add a descriptive readme for the mobile client

Open
  • Is something wrong?
#1 0 comments 0 reactions 0 assignees View on GitHub

@ssensalo is already working on this.

Since Jun 16, 2020.

  • #4 by @ssensalo — open

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript
Domain
documentation

Research direction

Start with the mobile client repository and inspect its existing README and project setup files to identify the local installation steps and required commands. Document the complete setup flow in the README; done means a newcomer can install and run the project locally from the instructions alone.

Written by the indexing model from the issue text.

Description

Add all the steps needed to install the project on the local environment including all the necessary commands in the description.

Dominant language
JavaScript
Stars
0
Forks
0
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 BuildForSDG/Team-229-MobileClient

All issues in BuildForSDG/Team-229-MobileClient

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.