flux-core icon indicating copy to clipboard operation
flux-core copied to clipboard

docs: readme mention of contributing

Open vsoch opened this issue 1 month ago • 1 comments

Problem: the Code of Conduct (TBA), Governance, contacts, and how to contribute (Contributing guide) need to be easy to find at the root of the repository. Solution: add an expected Contributing section that references RFC 1. There is currently not CoC content there, but we will add soon. If/when this template is good for flux-core we will extend to other flux-framework projects (I will open similar PRs if that sounds good)!

ping @grondo @garlick

vsoch avatar Nov 30 '25 05:11 vsoch

Well, we've come a ways since this was submitted!

And actually I had forgotten about it when I submitted

  • #7245

which adds a pointer from the README.md introductory section to CONTRIBUTING.md, and updates CONTRIBUTING.md to include the recently added governance and CoC RFCs.

Do you think that will be sufficient or do we actually need a new section in the README.md, as proposed here?

garlick avatar Dec 18 '25 16:12 garlick

A contributor just needs to be able to find "how to contribute" quickly. The CONTRIBUTING.md is (to me) preferred over what I had here, which was a workaround to not having one.

I'll close here - and not an issue.

vsoch avatar Dec 18 '25 17:12 vsoch

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 83.66%. Comparing base (c637f28) to head (6c7b4ef). :warning: Report is 76 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #7217      +/-   ##
==========================================
+ Coverage   83.64%   83.66%   +0.02%     
==========================================
  Files         554      554              
  Lines       92467    92467              
==========================================
+ Hits        77342    77364      +22     
+ Misses      15125    15103      -22     

see 12 files with indirect coverage changes

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar Dec 18 '25 17:12 codecov[bot]