jukbot/thai-citizen-id-validator

HELP: Looking for contributors !!

Open

#37 opened on Sep 21, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (79 stars) (14 forks)auto 404
good first issuehelp wanted

Description

Hi, this repository is needed a maintainers here is the proposal todo list.

  • Migrate them to support typescript.
  • Improve more example documentation.
  • Migrate test tool from jest to vitest.
  • Remove deprecated code and other unused libs.
  • Migrate istanbul to nyc.
  • Migrate traditional hand manual build to vite build system.
  • Support Thai Passport number validation. (Need a consult)
  • Add return local address of citizen from validator function. (Need a external data)

Contributor guide

Tech stack
typescriptnodejs
Domain
toolingapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
TypeScript knowledgefamiliarity with Thai ID validation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Review the existing codebase, particularly the main validator function in src/validator.ts, to understand the current structure. For passport validation, research Thai passport number format and check digit algorithms. For address lookup, investigate if there is a public API or dataset for Thai citizen addresses; consider implementing a mock or requiring the user to provide data. Look at the open issue comments for any guidance from maintainers.