docs: flisk-sh/analytics has no SECURITY.md or CONTRIBUTING.md

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

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
github
Domain
documentation

Research direction

Start at the repository root: read README and the test setup (for a JavaScript repo, the scripts in package.json) to learn the exact test command, then write SECURITY.md pointing reporters at GitHub private vulnerability reporting and a CONTRIBUTING.md covering setup, tests, sign-off and PR size. The issue also asks for checks that these files exist and name a reporting route and the test command, so look at how existing tests are organised before adding them. Done means both files are at the root, GitHub shows the Security policy and Contributing links, and all tests pass.

Written by the indexing model from the issue text.

Description

agents area: runtime automation chore cli consistency dependencies developer-experience difficulty: easy documentation enhancement good first issue help wanted hygiene json-output priority: P3 starters tests

Problem

flisk-sh/analytics has no SECURITY.md or CONTRIBUTING.md. A person who finds a vulnerability has no private way to report it and may open a public issue. A new contributor has no short guide to run the tests or open a pull request.

Root Cause Analysis

The repository root holds only code, a README and a license. GitHub shows no "Security policy" tab and no contributing link. Sibling repos learn and grow already track the same gap (docs: no CONTRIBUTING.md or SECURITY.md).

TDD Fix Plan

  1. RED: Add a check that the repo root contains SECURITY.md naming a private reporting address or the GitHub private advisory link.
    GREEN: Add SECURITY.md.
  2. RED: Add a check that CONTRIBUTING.md exists and names the test command.
    GREEN: Add a short CONTRIBUTING.md (setup, tests, sign-off, PR size).

REFACTOR: Share one template across org repos.

Acceptance Criteria

  • SECURITY.md explains how to report privately
  • CONTRIBUTING.md names the test command
  • GitHub shows the Security policy and Contributing links
  • All new tests pass
  • Existing tests still pass
Dominant language
JavaScript
Stars
0
Forks
2
Avg merge
1h 33m
Merged PRs (30d)
7

Getting set up

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 flisk-sh/analytics

All issues in flisk-sh/analytics

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.