Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
42 changes: 42 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Flux Framework Contribution Guide

The Flux project welcomes all contributors. This short guide details how
to contribute to Flux Framework projects in a standardized and efficient
manner.

## Contribution RFCs

Contributions to Flux projects should adhere to the rules contained
in the following RFCs from the [flux-framework/rfc][1] project:

* [*RFC 1: Collective Code Construction Contract*][2]

Also known as *C4.1*. This RFC includes details on the construction
of proper commits, commit requests, and the Pull Request process
used by Flux Framework projects.

* [*RFC 2: Flux Licensing and Collaboration Guidelines*][3]

This RFC specifies licensing and collaboration goals and requirements
for Flux Framework projects.

* [*RFC 7: Flux Coding Style Guide*][4]

This RFC details the preferred code style guidelines for contributions
to Flux projects.

* [*RFC 47: Flux Framework Contributor Code of Conduct*][5]

Behave!

* [*RFC 48: Flux Framework Project Governance*][6]

This RFC describes the rules for the development and community
management of Flux projects.

[1]: https://github.com/flux-framework/rfc
[2]: https://flux-framework.rtfd.io/projects/flux-rfc/en/latest/spec_1.html
[3]: https://flux-framework.rtfd.io/projects/flux-rfc/en/latest/spec_2.html
[4]: https://flux-framework.rtfd.io/projects/flux-rfc/en/latest/spec_7.html
[5]: https://flux-framework.rtfd.io/projects/flux-rfc/en/latest/spec_47.html
[6]: https://flux-framework.rtfd.io/projects/flux-rfc/en/latest/spec_48.html
32 changes: 32 additions & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
This document contains a list of the Maintainers of this github repository.
For further information on the role of Maintainer and how to contribute
to this project, please refer to [CONTRIBUTING](CONTRIBUTING.md).

## Current Maintainers

| Maintainer | GitHub ID | Affiliation |
| ------------------ | ----------------------------------------------------- | ----------- |
| Al Chu | [chu11](https://github.com/chu11) | LLNL |
| Chris Dunlap | [dun](https://github.com/dun) | LLNL |
| Christopher Moussa | [cmoussa1](https://github.com/cmoussa1) | LLNL |
| Elsa Gonsiorowski | [gonsie](https://github.com/gonsie) | LLNL |
| James Corbett | [jameshcorbett](https://github.com/jameshcorbett) | LLNL |
| Jim Garlick | [garlick](https://github.com/garlick) | LLNL |
| Jae-Seung Yeom | [JaeseungYeom](https://github.com/JaeseungYeom) | LLNL |
| Mark Grondona | [grondo](https://github.com/grondo) | LLNL |
| Daniel Milroy | [milroy](https://github.com/milroy) | LLNL |
| Tapasya Patki | [tpatki](https://github.com/tpatki) | LLNL |
| Tom Scogland | [trws](https://github.com/trws) | LLNL |
| Vanessa Sochat | [vsoch](https://github.com/vsoch) | LLNL |
| Becky Springmeyer | [springme](https://github.com/springme) | LLNL |
| William Hobbs | [wihobbs](https://github.com/wihobbs) | LLNL |

## Maintainers Emeritus

| Maintainer | GitHub ID | Affiliation |
| ---------------- | ----------------------------------------------------- | ----------- |
| Dong Ahn | [dongahn](https://github.com/dongahn) | NVIDIA |
| Don Lipari | [lipari](https://github.com/lipari) | independent |
| Chris Morrone | [morrone](https://github.com/morrone) | LLNL |
| Stephen Herbein | [steVwonder](https://github.com/steVwonder) | NVIDIA |

21 changes: 21 additions & 0 deletions NOTICE.LLNS
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
This work was produced under the auspices of the U.S. Department of
Energy by Lawrence Livermore National Laboratory under Contract
DE-AC52-07NA27344.

This work was prepared as an account of work sponsored by an agency of
the United States Government. Neither the United States Government nor
Lawrence Livermore National Security, LLC, nor any of their employees
makes any warranty, expressed or implied, or assumes any legal liability
or responsibility for the accuracy, completeness, or usefulness of any
information, apparatus, product, or process disclosed, or represents that
its use would not infringe privately owned rights.

Reference herein to any specific commercial product, process, or service
by trade name, trademark, manufacturer, or otherwise does not necessarily
constitute or imply its endorsement, recommendation, or favoring by the
United States Government or Lawrence Livermore National Security, LLC.

The views and opinions of authors expressed herein do not necessarily
state or reflect those of the United States Government or Lawrence
Livermore National Security, LLC, and shall not be used for advertising
or product endorsement purposes.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,7 @@ The chapters are also interspersed with more design or "how does it work" type c
![img/flux-tree.png](img/flux-tree.png)
![img/submit.png](img/submit.png)

#### Release

Copy link
Member

Choose a reason for hiding this comment

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

I think you forgot to remove this, or update to the release code.

I will note that when I make new tutorial content, I typically do another release (for LLNL-PRES) so I don't know if it makes sense to put any single one here. I would generally not, but we can see what others think.

Copy link
Member Author

@wihobbs wihobbs Feb 7, 2026

Choose a reason for hiding this comment

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

We had some discussion in the coffee call about this and I asked Meg, who said that presentations released for external unlimited distribution can use the Creative Commons (with Attribution) license. I've now come full circle with you and wonder if it's necessary to have a license at all...I'm not clear on what the implied permission scope is if you have no license in a repo.

Copy link
Member Author

Choose a reason for hiding this comment

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

Some information on if you have no license in a repo is in the GitHub docs.

Copy link
Member

Choose a reason for hiding this comment

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

No license means "all rights reserved," which we probably do not want. Creative commons is not typically for code, and there is more of that than presentation here. We likely want a license that is more akin to MIT or Apache 2, which is in line with other projects we have. I would bring it up at a future Flux meeting and we can choose from the set of 3 that the other projects have.

SPDX-License-Identifier: LGPL-3.0