-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
adding top-leveal README and issue template
- Loading branch information
0 parents
commit 06c9f0a
Showing
2 changed files
with
144 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
<!--- | ||
Instructions: Please include the software name being requested in the Issue Title | ||
above. Then, please provide requested information for each of the sections below. | ||
All sections are required unless marked as (Optional). | ||
Notes: | ||
(1) Each section begins with "### SectionName" syntax. | ||
(2) For sections that include pre-defined checkboxes, [ ], please indicate your | ||
choice via [x] syntax. | ||
(3) Text enclosed in <!-- comment -> syntax provides additional information for | ||
certain sections and will not be shown on the resulting issue after submission. | ||
--> | ||
|
||
--- | ||
#### Software Name | ||
|
||
--- | ||
#### Public URL | ||
|
||
--- | ||
#### Technical Overview | ||
<!--- | ||
Please provide a brief summary of the component and indicate whether it | ||
provides complimentary functionality to existing OpenHPC components or | ||
introduces new functionality. | ||
--> | ||
|
||
--- | ||
#### Latest stable version number | ||
|
||
--- | ||
#### Open-source license type | ||
|
||
--- | ||
#### Relationship to component? | ||
- [ ] contributing developer | ||
- [ ] user | ||
- [ ] other | ||
|
||
If other, please describe: | ||
|
||
--- | ||
#### Build system | ||
- [ ] autotools-based | ||
- [ ] CMake | ||
- [ ] other | ||
|
||
If other, please describe: | ||
|
||
Does the current build system support staged path installations? | ||
For example: ```make install DESTIR=/tmp/foo``` (or equivalent) | ||
|
||
- [ ] yes | ||
- [ ] no | ||
|
||
--- | ||
#### Does component run in user space or are administrative credentials required? | ||
- [ ] user space | ||
- [ ] admin | ||
|
||
--- | ||
#### Does component require post-installation configuration. | ||
|
||
- [ ] yes | ||
- [ ] no | ||
|
||
If yes, please describe briefly: | ||
|
||
--- | ||
#### If component is selected, are you willing and able to collaborate with OpenHPC maintainers during the integration process? | ||
- [ ] yes | ||
- [ ] no | ||
|
||
--- | ||
#### Does the component include test collateral (e.g. regression/verification tests) in the publicly shipped source? | ||
- [ ] yes | ||
- [ ] no | ||
|
||
If yes, please briefly describe the intent and location of the tests. | ||
|
||
--- | ||
#### Does the component have additional software dependencies (beyond compilers/MPI) that are not part of standard Linux distributions? | ||
- [ ] yes | ||
- [ ] no | ||
|
||
If yes, please list the dependencies and associated licenses. | ||
|
||
--- | ||
#### Does the component include online or installable documentation? | ||
- [ ] yes | ||
- [ ] no | ||
|
||
If available online, please provide URL. | ||
|
||
--- | ||
#### [Optional]: Would you like to receive additional review feedback by email? | ||
|
||
<!--- | ||
Results from the review process will be posted to corresponding GitHub issue | ||
when available. If you would like to optionally receive additional private | ||
feedback, please check the yes box below and send an email to | ||
submissions@lists.openhpc.community with the corresponding Github Issue # | ||
created for your submission. | ||
--> | ||
|
||
- [ ] yes | ||
- [ ] no |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
## OpenHPC Component Submissions | ||
|
||
The OpenHPC Technical Steering Committee (TSC) welcomes community requests for new | ||
software additions for integration within future releases, and this repository | ||
is used to facilitate and track submissions. | ||
|
||
**Process Overview**: New component requests from community submitters will be | ||
reviewed on a periodic, rolling basis (at a minimum of a quarterly frequency). | ||
Interested submitters can begin the process by creating a new issue on this | ||
submission repository (can click | ||
[here](https://github.com/openhpc/submissions/issues/new) to begin). The issue | ||
creation requests a variety of details including (but not limited to): | ||
|
||
* Name, public URL | ||
* Technical overview | ||
* Brief explanation/justification for submission | ||
* Open-source license type | ||
* Software dependencies | ||
* Availability of test collateral | ||
* Optional: contact info (email) to receive additional private feedback from TSC review process | ||
|
||
Once submitted, a review by members of the TSC will be scheduled during the | ||
next review cycle with results publicly summarized on the Submissions Wiki | ||
site. The TSC endeavors to obtain a minimum of 5 reviews for each component | ||
from a variety of TSC members. Each new component requested will receive a | ||
selection notification categorization as follows: | ||
|
||
* Accept | ||
* Accept with changes | ||
* Reject until changes | ||
* Reject | ||
|
||
Accepted components will be scheduled for a future OpenHPC release and | ||
maintainers will collaborate with submitters as appropriate to finalize the | ||
integration. | ||
|