Open Source Docs

Conversation

1. Survey

Agent:

Which parts of the open-source strategy do you want to implement? Reply with the numbers, a range, or "all".

1. README.md
2. LICENSE
3. REUSE.toml
4. CONTRIBUTING.md
5. SECURITY.md
6. CODE_OF_CONDUCT.md
7. GOVERNANCE.md
8. CHANGELOG.md
9. Issue and pull request templates in .github/
10. GitHub Actions workflows in .github/workflows/
11. Dependabot in .github/
12. Conventional commits
13. Commit authentication with GPG + DCO
14. Git flow and pull requests
15. ARCHITECTURE_DECISIONS.md

From your message I understand 1, 2, 4 and 5. Confirm or add more.

User: 1, 2, 4, 5

2. Step 0: what already exists

Agent:

These files already exist in the repository:

• README.md (1.2 KB, first line: # React + Vite)

What should I do with it?

1. Overwrite: replace it with the generated one.
2. Merge: keep what you wrote and add only what is missing.
3. Skip: leave it untouched and generate nothing for it.
4. Write .new: generate README.md.new next to it (default).

LICENSE, CONTRIBUTING.md and SECURITY.md do not exist yet, so they will be created directly.

User: merge

3. License

Agent:

You said MIT. Do you confirm? Remember that all of these licenses are delivered with no warranties.

User: Yes, MIT.

4. Project data

Agent:

A few details before I write anything

1. In which language should the documentation be generated? (English by default)
2. What is the project name?
3. How long will it take to review and resolve a contribution, and what is the maintainers' availability (for example, are they students)?
4. Was the project built at a hackathon? If so, which one?
5. Full name and email address of the maintainers?

User: English. "Pulse Dashboard". About a week, I work on it in my spare time. No hackathon. Jane Doe jane@example.com

5. Generation

The agent works without further questions

1. Reads only the references for the marked options: readme.md, contributing.md and security.md (license.md was already read in step 3).
2. Downloads the MIT text from the canonical SPDX source into LICENSE, copies it to LICENSES/MIT.txt, and fills in the year (2026) and the copyright holder (Jane Doe). The license text is never typed by hand.
3. Writes docs/COMPONENTS_LICENSE.md, explaining why MIT was chosen and how it fits the licenses of the project's dependencies (React and the rest of package.json).
4. Merges README.md: keeps the existing content and adds the purpose, features, installation, usage examples, configuration, an architecture diagram (Mermaid), a supported platforms table, troubleshooting and support channels. The REUSE and OpenSSF badges are left commented out with sign-up instructions, because the project is not registered yet.
5. Writes CONTRIBUTING.md: thanks to contributors, the one-week review expectation, environment setup and build steps, coding standards derived from the project's existing ESLint/Prettier configuration, tests, the pull request process and the definition of done.
6. Writes SECURITY.md: supported versions, private reporting channel (GitHub Private Vulnerability Reporting or jane@example.com), response timelines, known limitations and coordinated disclosure policy.

Result

Files delivered

pulse-dashboard/
├── README.md                    # merged with the existing one
├── LICENSE                      # MIT, downloaded from SPDX
├── CONTRIBUTING.md              # new
├── SECURITY.md                  # new
├── LICENSES/
│   └── MIT.txt                  # copy of LICENSE
└── docs/
    └── COMPONENTS_LICENSE.md    # rationale for choosing MIT

Final summary shown to the user

Agent:

Done. Here is what changed:

Verification

Next steps for you: enable Private Vulnerability Reporting in the repository's Security tab, and register the project on bestpractices.dev and scorecard.dev to activate the badges that are commented out in the README.