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

Add SECURITY.md and CONTRIBUTING.md

Open Beginner friendly
  • Is something wrong?
#18 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
72/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
flutter
Domain
documentation

Research direction

Create SECURITY.md and CONTRIBUTING.md at the repository root. Check the existing README for any setup steps to reuse, and run flutter analyze and flutter test yourself so the commands you document are accurate. Done when both files exist, SECURITY.md explains private reporting through GitHub's vulnerability reporting, and CONTRIBUTING.md covers setup, the analyze and test commands, and the preference for small pull requests.

Written by the indexing model from the issue text.

Description

documentation good first issue
  • SECURITY.md: how to report a vulnerability privately (GitHub private vulnerability reporting).
  • CONTRIBUTING.md: how to set up the project, run flutter analyze and flutter test, and the preference for small, single-purpose pull requests.
Dominant language
C++
Stars
1
Forks
0
Avg merge
13m
Merged PRs (30d)
9

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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 pablolambo/FlashRead

All issues in pablolambo/FlashRead

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.