Skip to content

Add relevant docs - #15

Merged
rene merged 3 commits into
mainfrom
add-relevant-docs
Sep 5, 2026
Merged

rene merged 3 commits into
mainfrom
add-relevant-docs

Conversation

@rene

@rene rene commented Sep 5, 2026

Copy link
Copy Markdown
Owner

Relevant docs.

Add the Code of Conduct for rNES project.

Signed-off-by: Renê de Souza Pinto <rene@renesp.com.br>
@rene

rene commented Sep 5, 2026

Copy link
Copy Markdown
Owner Author

@claude

@github-actions

github-actions Bot commented Sep 5, 2026

Copy link
Copy Markdown

Claude encountered an error —— View job


I'll analyze this and get back to you.

2 similar comments
@github-actions

github-actions Bot commented Sep 5, 2026

Copy link
Copy Markdown

Claude encountered an error —— View job


I'll analyze this and get back to you.

@github-actions

github-actions Bot commented Sep 5, 2026

Copy link
Copy Markdown

Claude encountered an error —— View job


I'll analyze this and get back to you.

@github-actions

github-actions Bot commented Sep 5, 2026

Copy link
Copy Markdown

Claude finished @rene's task —— View job


Review

  • Read changed files
  • Check CLAUDE.md for repo instructions
  • Review documentation for accuracy and quality
  • Post feedback

The three files (CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md) are well-written and clearly tailored to rNES — they are not generic templates. A few issues worth addressing before merge:

CONTRIBUTING.md — missing section

The Table of Contents at line 24 lists [Suggesting features](#suggesting-features), but there is no corresponding ## Suggesting features section in the file. Either add the section or remove the ToC entry to avoid a broken anchor link.

CONTRIBUTING.md — commit message convention inconsistency

The commits in this PR use a non-conventional style ("Add Contributing guidelines") rather than the kernel-style subsystem: imperative summary that the document itself mandates (e.g., docs: Add CONTRIBUTING.md). This is a minor self-referential inconsistency, but something to keep in mind for future docs commits.

CONTRIBUTING.md — clang-format version

Line 134 pins CI to clang-format 21. That version is very recent (as of mid-2025) and may not be available in standard package repositories on older systems. It might be worth noting the minimum version that is generally compatible, or pointing contributors to the CI image for reference.

SECURITY.md — "Latest release (1.0)"

Line 17 hardcodes the release version as 1.0. If rNES releases a 1.1 or 2.0, this table will be stale. Consider using a relative reference ("Latest tagged release") instead of pinning a version number in the doc.

Overall

The content is accurate relative to the codebase (paths, mapper list, build system targets, commit examples), the cross-references between files are correct, and all three commits are properly signed off. These are small improvements — the docs are solid as-is and would be an improvement over having nothing.

rene added 2 commits September 5, 2026 18:43
Add Security policy guide.

Signed-off-by: Renê de Souza Pinto <rene@renesp.com.br>
Add CONTRIBUTING.md file, which contains the contributing guidelines.

Signed-off-by: Renê de Souza Pinto <rene@renesp.com.br>
@rene
rene force-pushed the add-relevant-docs branch from d517659 to 92e02ca Compare September 5, 2026 16:43
@rene

rene commented Sep 5, 2026

Copy link
Copy Markdown
Owner Author

@claude

@github-actions

github-actions Bot commented Sep 5, 2026

Copy link
Copy Markdown

Claude finished @rene's task —— View job


Review

  • Read changed files
  • Review documentation for accuracy and quality
  • Post feedback

The three files are well-written and clearly tailored to rNES. Here are the issues I found:

CONTRIBUTING.md:24 — broken ToC anchor

The Table of Contents includes:

- [Suggesting features](#suggesting-features)

but no ## Suggesting features section exists anywhere in the file. This is a dangling link — either add the section or remove the ToC entry.

CONTRIBUTING.md:134 — clang-format version note

CI uses clang-format 21.

clang-format 21 is very new and may not be available in standard package repos on older distros. It's worth pointing contributors to the CI image or at minimum noting the actual minimum version that produces compatible output.

CONTRIBUTING.md:244@rene inline mention

The sentence rNES was written in @rene's spare time will render as a GitHub user mention, which is likely intentional, but worth being aware of if the repo is ever transferred or the username changes.

CONTRIBUTING.md — commit convention self-inconsistency

The document mandates subsystem: imperative summary style commits (e.g., docs: Add CONTRIBUTING.md), but the commits in this PR use plain English titles ("Add Contributing guidelines"). Minor, but worth correcting on future doc commits to lead by example.

SECURITY.md — "Latest release" row

The supported versions table references "Latest release" without pinning a version string — that's actually good (avoids the stale-version problem noted in the previous review). No action needed here.

CODE_OF_CONDUCT.md — no issues found. Standard Contributor Covenant 2.1 with correct project-specific customizations (GitHub repo URL, private advisory link for CoC reports).

Overall: solid docs that reflect the actual codebase. The only blocker is the broken #suggesting-features ToC link in CONTRIBUTING.md.


@rene
rene merged commit a06f912 into main Sep 5, 2026
2 checks passed
@rene
rene deleted the add-relevant-docs branch September 5, 2026 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant