Skip to content

Commit

Permalink
adding review for spot
Browse files Browse the repository at this point in the history
Signed-off-by: vsoch <vsoch@users.noreply.github.com>
  • Loading branch information
vsoch committed Jul 23, 2021
1 parent f43b362 commit 7024474
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 11 deletions.
5 changes: 5 additions & 0 deletions COMMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,8 @@ I can have them in one place.
## Spindle

At face value, Spindle seems like it's undervalued, and I say this because the problem seems very real and overlooked, although I haven't encountered it myself. The reason is that it might not be given enough attention is that the software presents itself very technically - "a tool for improving the performance of dynamic library and python loading in HPC enviornments." If I'm a user of such an environment, I don't directly see how this relates to me, or if it does, that using Spindle will improve doing my research. But being able to frame this problem in a way that is relatable to the general HPC user depends on if the general HPC user really faces this problem: "We encountered cases where it took over ten hours for a dynamically-linked MPI application running on 16K processes to reach main." So step 1 is identifying the audience for Spindle, describing (in a little more detail) the different use cases (not once in a long time or simulated, but actual day to day, and is it only MPI? What percentage of users use MPI?) and then deciding if there could be more interest in the community. I have quite a few suggestions to make the contributor friendliness (CF) of the project better if we decide it should be. For example, it would be very useful to provide a dummy cluster with containers, and then install spindle for a user to quickly interact. Spindle also uses LGPL which is OSI approved, but has "special cases" for [Google](https://opensource.google/docs/thirdparty/licenses/#LinkingRequirements) (which might suggest that they don't readily use or contribute as they would MIT or Apache, etc.).

## Spot

For the series of spot repos (there is one for a front end, a back end, and a container) it would be much easier to navigate if there
was a single documentation interface that puts them all in context.
22 changes: 11 additions & 11 deletions _cfa/cfa-LLNL-spotbe.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,23 @@ for contributor friendliness.

## CFA-description

- [ ] GitHub repository description (modified with "edit" button) is filled in.
- [ ] The description is also provided at the top of the README.md
- [ ] Clearly states similar projects, competitors, prior art, etc.
- [x] GitHub repository description (modified with "edit" button) is filled in.
- [x] The description is also provided at the top of the README.md
- [x] Clearly states similar projects, competitors, prior art, etc.

## CFA-need

- [ ] Use cases are clearly stated in the README.md
- [ ] The project does not use domain-specific jargon, but if it does, it is clearly explained or offers references.
- [x] Use cases are clearly stated in the README.md
- [x] The project does not use domain-specific jargon, but if it does, it is clearly explained or offers references.

## CFA-license

- [x] The GitHub repository has a clear license
- [ ] The license is an OSI-approved license
- [x] The license is an OSI-approved license

## CFA-build

- [ ] The documentation or README.md states how to build or install the software.
- [x] The documentation or README.md states how to build or install the software.
- [ ] The project uses an established build framework or strategy
- [ ] Requirements or dependencies are clearly stated.
- [ ] The software can quickly output a version.
Expand Down Expand Up @@ -67,15 +67,15 @@ for contributor friendliness.

## CFA-developer

- [ ] The project has a CHANGELOG and/or provides changes in release notes.
- [x] The project has a CHANGELOG and/or provides changes in release notes.
- [ ] The project provides a pull request template to guide the developer through steps.
- [ ] A container is provided for quick usage/interaction.
- [x] A container is provided for quick usage/interaction.

## CFA-quality

- [ ] Naming of variables, classes, and functions is easy to understand.
- [x] Naming of variables, classes, and functions is easy to understand.
- [ ] The code is robustly commented.
- [ ] Files and directories are organized meaningfully.
- [x] Files and directories are organized meaningfully.

## CFA-tests

Expand Down

0 comments on commit 7024474

Please sign in to comment.