README needs content

Open Beginner friendly
#19 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
82/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Domain
documentation

Research direction

Start by reviewing the existing hackmd process and the project's README. Update the README with a description of what the project is and instructions for how to run it. Done means a new reader can understand the project and run it from the README.

Written by the indexing model from the issue text.

Description

I can see that you've made a lot of effort with writing down your process and thoughts in a hackmd 👏. Try to do the same for your README - at the very least include a description of what the project is and how to run it. Try to write this before you even start coding - otherwise it becomes a last minute thing (this has happened to me so many times 🙃)

Dominant language
JavaScript
Stars
0
Forks
0
No merged PRs in 30d

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.

More from fac-14/NDJS-API

All issues in fac-14/NDJS-API

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.