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 an "About" sheet #1108

Open
6 tasks
hepcat72 opened this issue Aug 4, 2024 · 0 comments
Open
6 tasks

Add an "About" sheet #1108

hepcat72 opened this issue Aug 4, 2024 · 0 comments
Labels
component:submission Submission process page and logic priority:3-medium Not required to meet release goals, but somewhat important type:feature New feature or request

Comments

@hepcat72
Copy link
Collaborator

hepcat72 commented Aug 4, 2024

FEATURE REQUEST

Inspiration

See #1034

Description

Include:

  • Instructions
  • Study doc version
  • Time- and/or date-stamp (include in the file name)
  • Add stats: number of errors, records that would be created, data added, etc.

Alternatives

None

Dependencies

None

Comment

None


ISSUE OWNER SECTION

Assumptions

  1. List of assumptions that the code will not explicitly address/check
  2. E.g. We will assume input is correct (explaining why there is no validation)

Limitations

  1. A list of things this work will specifically not do
  2. E.g. This feature will only handle the most frequent use case X

Affected Components

  • change: File path or DB table ...
  • add: Environment variable or server setting
  • delete: External executable or cron job

Requirements

  • 1. List of numbered conditions to be met for the feature
  • 2. E.g. Every column/row must display a value, i.e. cannot be empty
  • 3. Numbers for reference & checkboxes for progress tracking

DESIGN

Interface Change description

None provided

Code Change Description

None provided

Tests

  • 1. A description of at least one test for each requirement above.
  • 2. E.g. Test for req 2 that there's an exception when display value is ''
  • 3. Numbers for reference & checkboxes for progress tracking
@hepcat72 hepcat72 added type:feature New feature or request priority:3-medium Not required to meet release goals, but somewhat important component:submission Submission process page and logic labels Aug 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:submission Submission process page and logic priority:3-medium Not required to meet release goals, but somewhat important type:feature New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant