Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add metadata tag and acknowledgement to PTCs #43

Merged
merged 5 commits into from
Jun 23, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Adopt Automated Correctness Testing in a Legacy Software Project

## Target
Expand Down Expand Up @@ -30,3 +31,8 @@ As a developer on a legacy software project/product, I want my team to adopt inc
* The PTC [Continuous Integration](https://github.com/bssw-psip/ptc-catalog/blob/master/catalog/ContinuousIntegration.md) describes steps/levels in how to take an existing set of automated tests and how run them, how to display their results, and how to use them to gate different development, integration, and other processes.
* The PTC [Test Coverage](https://github.com/bssw-psip/ptc-catalog/blob/master/catalog/TestCoverage.md) is similar to this PTC except this PTC is consistent with advice in the book ["Working Effectively with Legacy Code"](https://bssw.io/items/working-effectively-with-legacy-code) by Robert Martin in that it does not expect that detailed unit tests will be added to cover all of the existing legacy code and that is okay.
* The PTC [Test Driven Development](https://github.com/bssw-psip/ptc-catalog/blob/master/catalog/TestDrivenDevelopment.md) describes the phased introduction on test driven development and would seem to mostly apply to new code that is being written but does not address changes to existing code.


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/AgileAdoption.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Agile Adoption

## Target
Expand All @@ -23,3 +24,8 @@ As a project leader, I have heard of teams that have adopted Agile workflows and
## Comments

1. Examples of Agile processes include stand-up meetings, additional Kanban board columns, user stories, epic/story/task work breakdowns, etc.


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/AlgorithmProductization.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Algorithm Productization Checklist

## Target
Expand Down Expand Up @@ -29,3 +30,8 @@ As an algorithm developer, I want to develop and productize an ECP-relevant algo

- Some algorithms may go through a phase with both VTK-h and VTK-m code
- Development of VTK-m filters must adhere to the [VTK-m contributing guide](https://gitlab.kitware.com/vtk/vtk-m/blob/master/CONTRIBUTING.md)


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/CodingStandards.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Adopting Consistent Coding Standards

## Target
Expand Down Expand Up @@ -36,3 +37,8 @@ As a software developer on a project that has a defined coding standard, I want
## Comments

Percentages used in Variant B may reflect number of lines in the code, team expertise for understanding and documenting code, timeline for this PTC and several other factors. When the team considers a task completed in the last step will vary from team to team.


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/CommunityBuilding.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Build a Local Community of Practice

## Target
Expand All @@ -23,3 +24,8 @@ As an individual software contributor I want to build a community so that I can
## Comments

1. [Building Connections and Community within an Institution](https://bssw.io/blog_posts/building-connections-and-community-within-an-institution)


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/ContinuousIntegration.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Continuous Integration

## Target
Expand Down Expand Up @@ -33,3 +34,8 @@ As a person responsible for software quality and correctness for my project, I w
| 5 | Team establishes policy to bypass required testing in the rare cases it is appropriate. |

## Comments


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/CreatingCommunityPolicies.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Creating Community Policies

## Target
Expand Down Expand Up @@ -25,3 +26,8 @@ As a developer of a software library, I want to collaborate with others to estab

- This card was inspired by the BSSw.io article [What are Interoperable Software Libraries? Introducing the xSDK](https://bssw.io/items/what-are-interoperable-software-libraries-introducing-the-xsdk)
- Once this card is completed, teams are encouraged to loop back to step 2 for further revisions; also possibly pursue a related topic: coordinated release of software packages that are compatible with community software policies |


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/DeveloperDocumentation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Developer Documentation

## Target
Expand Down Expand Up @@ -33,3 +34,8 @@
- [ReadTheDocs](https://readthedocs.org)
- [WriteTheDocs](https://www.writethedocs.org)



### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/EpicsForTracking.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Using Epics in Jira for Tracking and Collaboration

## Target
Expand All @@ -22,3 +23,8 @@ As a project manager I want all staff to write Jira Epics representing LOE so th

## Comments



### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/EvaluateAndUseAnIssueTracker.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Evaluate and Use an Issue Tracker

## Target
Expand Down Expand Up @@ -34,3 +35,8 @@ As a software developer, I want to keep track of bugs and user feature requests
----

Thanks @prwolfe @jeanshuler for the help!


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/GitWorkflow.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Adopt A Git Workflow that Supports Testing and Peer-review

## Target
Expand Down Expand Up @@ -25,3 +26,8 @@ so that all code changes are peer-reviewed and tested.
- Automated testing is testing branches within Github/Gitlab in isolation
- The term "merge request" can be used interchangeably with "pull request"
- Steps 4 & 5 can be done in either order


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/ImprovingProjectVisibility.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Improving Project Visibility: Using a Communication Plan

## Target
Expand Down Expand Up @@ -28,3 +29,8 @@ within a specified time frame.
3. Develop and implement an actionable plan to publicize the project to the community (e.g. for a research community, through posters and research publications) within a specified time frame. The plan should be achievable by team.
4. The team has defined how "active" a social media presence will be required (e.g. 1 tweet per day, 1 blog post per week, etc.)
5. The communication plan may be revised as the requirements for "ideal" visibility shift.


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/IntegratedSoftwareDocumentation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Integrated Software Documentation

## Target
Expand Down Expand Up @@ -34,3 +35,8 @@ Some useful technologies to consider are
* [Sphinx](http://www.sphinx-doc.org/en/master/)
* [ReadTheDocs](https://readthedocs.org)
* [Jekyll](https://jekyllrb.com) and Jekyll's [Documentation Theme](https://jekyllthemes.io/jekyll-documentation-themes)


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/IssuesForDesign.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Using Issues on GitHub/GitLab for Design and Development

## User Story
Expand All @@ -18,3 +19,8 @@ As a software engineer I want my small team to use issues for developing new mod
## Comments

1. To learn more see [What is Issue Tracking?](https://bssw.io/items/what-is-issue-tracking)


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/MultiSystemPerformanceTesting.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Multi-System Performance Testing

## Target
Expand All @@ -24,3 +25,8 @@ As a software engineer I want to incorporate regular performance testing into my
- The [Performance Regression Testing Card](PerformanceRegressionTesting.md) has details on developing a performance regression tests itself.

**This card originally proposed by [Boyana Norris](https://github.com/brnorris03)**


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/OnboardingANewTeamMember.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Onboarding A New Team Member

## Target
Expand All @@ -18,3 +19,8 @@ become contributors to our project using our policies for software development.
| 2 | The team onboarding process is used by supervisors for new hires.|
| 3 | The team onboarding process is approved by HR. Regular reviews of the process are undertaken.|
| 4 | All team members are familiar with, and actively participate in, the onboarding process.|


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/OpenSource.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Open Source

## Target
Expand All @@ -19,3 +20,8 @@ As a software developer I want to make my project open source so that I can enga
| 4 | The backlog of bugs/issues is moved to an established, third-party hosting platform |

## Comments


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/PeerProgress.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Tracking and Adjusting to Progress in Peer Projects

## Target
Expand Down Expand Up @@ -29,3 +30,8 @@ can also be a source of new collaborators and increased productivity.
- Tracking peer progress looks different in different disciplines, but is especially
important where software development is involved because of the potential win if
datastructures and API-s can be made inter-operable early on.


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/PerformanceRegressionTesting.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Performance Regression Testing

## Target
Expand Down Expand Up @@ -29,3 +30,8 @@ and others. The choice of measurements will inform the test(s) that need to be w
- A performance test should be able to be checked relatively easily yet it is one that also exercises the code adequately.
- Additional steps in this PTC might include repeating these steps to support another use case, set of measurements,
and/or more tests.


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# PTC Catalog Table of Contents

The table below lists the currently available Progress Tracking Cards (PTCs) with a brief description of their goals.
Expand Down Expand Up @@ -42,3 +43,8 @@
| [Transmedia Learning Framework for Python](TransmediaLearningForPython.md) | Learn Python enough to more efficiently recall functionality on demand. |
| [Promote User Confidence in Software Updates ](UserConfidenceSoftwareUpdates.md) | Ensure users are confident of application performance and behavior changes made by an update/new release. |
| [End-user Documentation](UserDocumentation.md) | Create end-user documentation for a software project |


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/RequirementsEngineering.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Requirements Engineering
## Target

Expand Down Expand Up @@ -32,3 +33,8 @@ Created at the SEA ISC'22 PSIP tutorial by Erik Kluzek, Christina Holt, Edward H
[What Are CSE Software Requirements?](https://bssw.io/items/what-are-cse-software-requirements)

[An Introduction to User Stories and How to Write Them](https://bssw.io/items/an-introduction-to-user-stories-and-how-to-write-them)


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/SoftwareLicensing.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Licensing Your Software

## Target
Expand Down Expand Up @@ -27,3 +28,8 @@ As a contributor to a software package, I want to ensure that our work has an ap

[1]: http://softwarefreedom.org/resources/2012/ManagingCopyrightInformation.html



### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/SourceManagement.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# Source Management

## Target
Expand All @@ -17,3 +18,8 @@ Use Source Management System (SMS).


## Comments


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/THGCodingStandards.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# THG Coding Standards

## Target
Expand Down Expand Up @@ -43,3 +44,8 @@ As an HDF5 library developer or community contributor, I want support so that I
## Other Remarks

This card was created by the [THG PSIP Pilot project](https://www.osti.gov/biblio/1698291-psip-hdf5pilot-project-final-report).


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/THGGitHubMigration.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# THG GitHub Migration

## Target
Expand Down Expand Up @@ -32,3 +33,8 @@ As a community contributor, I want my contributions to be held to the same stand
## Other Remarks

This card was created by the [THG PSIP Pilot project](https://www.osti.gov/biblio/1698291-psip-hdf5pilot-project-final-report).


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
6 changes: 6 additions & 0 deletions catalog/THGReferenceManual.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[metadata:tags]:- "bssw-psip-ptc"
# THG Reference Manual

## Target
Expand Down Expand Up @@ -33,3 +34,8 @@ As an HDF5 stakeholder, I want an easy-to-use reference manual, so that I can ha
## Other Remarks

This card was created by the [THG PSIP Pilot project](https://www.osti.gov/biblio/1698291-psip-hdf5pilot-project-final-report).


### Acknowledgement

This Project Tracking Card originated from the [PSIP PTC Catalog](https://bssw-psip.github.io/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.
Loading