Add metadata tag and acknowledgement to PTCs #43
Conversation
|
Sounds good to me! 😄 |
|
@mrmundt thanks for your progress on this. One thing to consider -- We are moving along the path of PSIP automation so the toolkit outlives the ECP project. So...as you have "ecp" in the metadata tag -- how would you like to address this? Thanks! |
|
@elaineraybourn - That's a good question. I originally had the tag as That being said, another option I like is |
|
@mrmundt I like bssw-psip-ptc better. Bssw won't change soon. |
|
@elaineraybourn - Changed! Any thoughts on the acknowledgement language? |
|
@mrmundt can you make a few suggestions to choose from? What would Uncle Bob do? WWUBD. :-) |
|
@elaineraybourn - Sorry, I forget that you're not primarily a software developer! If you click on "Files changed", you can see that I added some language already based on what I thought was good. The language I added to each file was: AcknowledgementThis Project Tracking Card originated from the PSIP PTC Catalog. The development of the PSIP PTC Catalog was supported by the Exascale Computing Project (17-SC-20-SC), a collaborative effort of the U.S. Department of Energy Office of Science and the National Nuclear Security Administration. |
As part of the PSIP automation process, we want to add some metadata that can be traced (via github searches) when a project uses one of the catalog cards.
This PR recommends adding both metadata to the top (which will not render on GitHub or GitLab but will be in the raw source code) and an acknowledgement at the bottom. In this way, if a project is copy-pasting an existing PTC into their own repo, it should be searchable in two ways.
NOTE: The choice
ecp-psip-ptcis for uniqueness. In searching all of GitHub, I didn't find a use of that tag or phrase anywhere that is unrelated to ECP.EDIT: Partially resolves #41