docs: readme mention of contributing #7217
Conversation
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. Signed-off-by: vsoch <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. 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 🚀 New features to boost your workflow:
|
| #### Contributing | ||
|
|
||
| We are an open-source community and welcome contributions and feedback. For Governance, Contributing, contacts, and Code of Conduct guides, see [RFC 1.](https://flux-framework.readthedocs.io/projects/flux-rfc/en/latest/spec_1.html). | ||
|
|
There was a problem hiding this comment.
I haven't had a chance to read the whole HPSF proposal yet but my understanding is you want to create a reusable section here that points to collaboration-related RFCs.
Suggestions:
- drop paragraph 2 since that becomes redundant
- create a new RFC for Code of Conduct since that is a fairly standalone topic from RFC 1
- reference RFC 2 (licensing) and RFC 7 (coding style) here as well
- use a list form for the RFC links with the verbatim RFC titles
- drop "contacts" (or elaborate on what is intended by that)
There was a problem hiding this comment.
create a new RFC for Code of Conduct since that is a fairly standalone topic from RFC 1
I can do that. Can you tell me where to put it / what to name it in the rfc repository? I'll get a draft started for discussion - these things have been made often enough that there are good templates, and we can adjust one as needed.
Once we have that, I can come back here and update the mention.
There was a problem hiding this comment.
Actually, maybe we should pause here and wait for our discussion about the overall plan.
There was a problem hiding this comment.
Sorry, I didn't refresh and didn't see your comment. I think it would be OK to submit a CoC RFC PR. I'd just call it "Flux Framework Contributor Code of Conduct" or similar, and just grab the next RFC number and follow the pattern of the other RFCs.
There was a problem hiding this comment.
Agreed, probably one for CoC and one for governance, unless we want to extend/amend RFC1 as the governance, but most of it is conduct so... yeah, might be easiest to have two explicit documents and reference back.
There was a problem hiding this comment.
For reference:
- feat: code of conduct rfc#480 (Code of Conduct, RFC 47)
- feat: governance document rfc#481 (Governance, RFC 48)
We will want to merge 47 and rebase 48 on it.
3 participants
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