From 06c9f0acee0576c207e1eabcd19e3f9c7f0b61eb Mon Sep 17 00:00:00 2001 From: "Karl W. Schulz" Date: Wed, 14 Sep 2016 11:11:21 -0500 Subject: [PATCH] adding top-leveal README and issue template --- .github/ISSUE_TEMPLATE.md | 108 ++++++++++++++++++++++++++++++++++++++ README.md | 36 +++++++++++++ 2 files changed, 144 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 README.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..87dca8c --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,108 @@ + + +--- +#### Software Name + +--- +#### Public URL + +--- +#### Technical Overview + + +--- +#### 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? + + + +- [ ] yes +- [ ] no diff --git a/README.md b/README.md new file mode 100644 index 0000000..47965c5 --- /dev/null +++ b/README.md @@ -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. +