Skip to content

Commit 5ef6632

Browse files
committed
add NOTICE.LLNS, LICENSE, MAINTAINERS, CONTRIBUTING
Problem: RFC 2 and RFC 48 set out guidelines for flux-framework repositories, and the Tutorials repository is currently lacking some of the things it mandates or recommends. Add a LICENSE, LLNS notice, and update the README and other files.
1 parent ef36e93 commit 5ef6632

4 files changed

Lines changed: 99 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Flux Framework Contribution Guide
2+
3+
The Flux project welcomes all contributors. This short guide details how
4+
to contribute to Flux Framework projects in a standardized and efficient
5+
manner.
6+
7+
## Contribution RFCs
8+
9+
Contributions to Flux projects should adhere to the rules contained
10+
in the following RFCs from the [flux-framework/rfc][1] project:
11+
12+
* [*RFC 1: Collective Code Construction Contract*][2]
13+
14+
Also known as *C4.1*. This RFC includes details on the construction
15+
of proper commits, commit requests, and the Pull Request process
16+
used by Flux Framework projects.
17+
18+
* [*RFC 2: Flux Licensing and Collaboration Guidelines*][3]
19+
20+
This RFC specifies licensing and collaboration goals and requirements
21+
for Flux Framework projects.
22+
23+
* [*RFC 7: Flux Coding Style Guide*][4]
24+
25+
This RFC details the preferred code style guidelines for contributions
26+
to Flux projects.
27+
28+
* [*RFC 47: Flux Framework Contributor Code of Conduct*][5]
29+
30+
Behave!
31+
32+
* [*RFC 48: Flux Framework Project Governance*][6]
33+
34+
This RFC describes the rules for the development and community
35+
management of Flux projects.
36+
37+
[1]: https://github.com/flux-framework/rfc
38+
[2]: https://flux-framework.rtfd.io/projects/flux-rfc/en/latest/spec_1.html
39+
[3]: https://flux-framework.rtfd.io/projects/flux-rfc/en/latest/spec_2.html
40+
[4]: https://flux-framework.rtfd.io/projects/flux-rfc/en/latest/spec_7.html
41+
[5]: https://flux-framework.rtfd.io/projects/flux-rfc/en/latest/spec_47.html
42+
[6]: https://flux-framework.rtfd.io/projects/flux-rfc/en/latest/spec_48.html

MAINTAINERS.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
This document contains a list of the Maintainers of this github repository.
2+
For further information on the role of Maintainer and how to contribute
3+
to this project, please refer to [CONTRIBUTING](CONTRIBUTING.md).
4+
5+
## Current Maintainers
6+
7+
| Maintainer | GitHub ID | Affiliation |
8+
| ------------------ | ----------------------------------------------------- | ----------- |
9+
| Al Chu | [chu11](https://github.com/chu11) | LLNL |
10+
| Chris Dunlap | [dun](https://github.com/dun) | LLNL |
11+
| Christopher Moussa | [cmoussa1](https://github.com/cmoussa1) | LLNL |
12+
| Elsa Gonsiorowski | [gonsie](https://github.com/gonsie) | LLNL |
13+
| James Corbett | [jameshcorbett](https://github.com/jameshcorbett) | LLNL |
14+
| Jim Garlick | [garlick](https://github.com/garlick) | LLNL |
15+
| Jae-Seung Yeom | [JaeseungYeom](https://github.com/JaeseungYeom) | LLNL |
16+
| Mark Grondona | [grondo](https://github.com/grondo) | LLNL |
17+
| Daniel Milroy | [milroy](https://github.com/milroy) | LLNL |
18+
| Tapasya Patki | [tpatki](https://github.com/tpatki) | LLNL |
19+
| Tom Scogland | [trws](https://github.com/trws) | LLNL |
20+
| Vanessa Sochat | [vsoch](https://github.com/vsoch) | LLNL |
21+
| Becky Springmeyer | [springme](https://github.com/springme) | LLNL |
22+
| William Hobbs | [wihobbs](https://github.com/wihobbs) | LLNL |
23+
24+
## Maintainers Emeritus
25+
26+
| Maintainer | GitHub ID | Affiliation |
27+
| ---------------- | ----------------------------------------------------- | ----------- |
28+
| Dong Ahn | [dongahn](https://github.com/dongahn) | NVIDIA |
29+
| Don Lipari | [lipari](https://github.com/lipari) | independent |
30+
| Chris Morrone | [morrone](https://github.com/morrone) | LLNL |
31+
| Stephen Herbein | [steVwonder](https://github.com/steVwonder) | NVIDIA |
32+

NOTICE.LLNS

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
This work was produced under the auspices of the U.S. Department of
2+
Energy by Lawrence Livermore National Laboratory under Contract
3+
DE-AC52-07NA27344.
4+
5+
This work was prepared as an account of work sponsored by an agency of
6+
the United States Government. Neither the United States Government nor
7+
Lawrence Livermore National Security, LLC, nor any of their employees
8+
makes any warranty, expressed or implied, or assumes any legal liability
9+
or responsibility for the accuracy, completeness, or usefulness of any
10+
information, apparatus, product, or process disclosed, or represents that
11+
its use would not infringe privately owned rights.
12+
13+
Reference herein to any specific commercial product, process, or service
14+
by trade name, trademark, manufacturer, or otherwise does not necessarily
15+
constitute or imply its endorsement, recommendation, or favoring by the
16+
United States Government or Lawrence Livermore National Security, LLC.
17+
18+
The views and opinions of authors expressed herein do not necessarily
19+
state or reflect those of the United States Government or Lawrence
20+
Livermore National Security, LLC, and shall not be used for advertising
21+
or product endorsement purposes.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,7 @@ The chapters are also interspersed with more design or "how does it work" type c
3535
![img/flux-tree.png](img/flux-tree.png)
3636
![img/submit.png](img/submit.png)
3737

38+
#### Release
39+
40+
SPDX-License-Identifier: LGPL-3.0
41+

0 commit comments

Comments
 (0)