Skip to content

docs: readme mention of contributing #7217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vsoch wants to merge 1 commit into
base: master
Choose a base branch
from
+4 −0
Open

docs: readme mention of contributing #7217

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ exits, Flux exits.
For more information on starting Flux in various environments and using it,
please refer to our [docs](https://flux-framework.readthedocs.io) pages.

#### 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).

Comment on lines +72 to +75
Copy link
Member

@garlick garlick Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copy link
Member Author

@vsoch vsoch Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

@garlick garlick Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, maybe we should pause here and wait for our discussion about the overall plan.

Copy link
Member

@garlick garlick Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

@trws trws Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

@vsoch vsoch Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll get in a draft for this later today. Thanks @trws and @garlick.

Copy link
Member Author

@vsoch vsoch Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For reference:

We will want to merge 47 and rebase 48 on it.

#### Release

SPDX-License-Identifier: LGPL-3.0
Expand Down
Loading