priscillatrevizan/regex-generator

[DOCS] Update documentation

Open

#9 opened on Oct 10, 2025

View on GitHub
 (3 comments) (0 reactions) (1 assignee)JavaScript (11 forks)auto 404
documentationgood first issuehacktoberfesthacktoberfest2025priority-medium

Repository metrics

Stars
 (13 stars)
PR merge metrics
 (PR metrics pending)

Description

TASK:

In the CONTRIBUTING.md document:

  • Include rules for opening PRs for the development branch in accordance with best practices.
  • Update the labels section to inform users that updating labels on GitHub is restricted to project maintainers. Contributors can suggest which labels to use when opening an issue or requesting assignment.

In README.md:

  • Update the README.md to link to the issues page instead of the list of open issues, thus avoiding documentation lags.

Contributor guide

Research direction
Update the CONTRIBUTING.md to include rules for opening PRs to the development branch and inform that label updates are restricted to maintainers. Update the README.md to link to the issues page instead of the open issues list.
Tech stack
javascript
Domain
full stackdocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90