Add relevant docs - #15
Conversation
Add the Code of Conduct for rNES project. Signed-off-by: Renê de Souza Pinto <rene@renesp.com.br>
|
Claude encountered an error —— View job I'll analyze this and get back to you. |
2 similar comments
|
Claude encountered an error —— View job I'll analyze this and get back to you. |
|
Claude encountered an error —— View job I'll analyze this and get back to you. |
|
Claude finished @rene's task —— View job Review
The three files (
The Table of Contents at line 24 lists
The commits in this PR use a non-conventional style ("Add Contributing guidelines") rather than the kernel-style
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.
Line 17 hardcodes the release version as 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. |
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>
d517659 to
92e02ca
Compare
|
Claude finished @rene's task —— View job Review
The three files are well-written and clearly tailored to rNES. Here are the issues I found:
The Table of Contents includes: but no
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.
The sentence
The document mandates
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.
Overall: solid docs that reflect the actual codebase. The only blocker is the broken |
Relevant docs.