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

Getting Started...

Open
#30 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
38/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
lua, react
Domain
documentation

Research direction

Review the API reference and existing project documentation to identify where users need guidance on getting started and including the library. Add a concise getting-started section covering the initial setup and import path, with enough information for a new user to begin using the library.

Written by the indexing model from the issue text.

Description

Is there any intention or possibility to add a getting started section to the API reference or elsewhere? I'm especially interested in trying this out, but I can't seem to find information in how to get started in including/importing the library into a project.

Dominant language
Luau
Stars
569
Forks
25
PR merge metrics
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 jsdotlua/react-lua

All issues in jsdotlua/react-lua

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.