Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: base
-
Labels:None
-
Story Points:1
-
Epic Link:
-
Team:Data Release Production
-
Urgent?:No
Description
The base package does not have a readme file, so it's unclear what it's for. The package name is also somewhat unfortunate, being so generic, but at least with a readme it would be clearer how important it is (if it is, in fact, important).
The README.rst for the base package is not compliant with the current recommended cookie cutter package README file. This ticket updates the base README.rst to that standard.
Attachments
Issue Links
- relates to
-
- Adopted
Activity
| Field | Original Value | New Value |
|---|---|---|
| Watchers | John Parejko [ John Parejko ] | John Parejko, John Swinbank, Russell Owen, Simon Krughoff, Tim Jenness [ John Parejko, John Swinbank, Russell Owen, Simon Krughoff, Tim Jenness ] |
| Team | SQuaRE [ 10302 ] |
| Summary | base has no readme | Give base an updated readme file |
| Status | To Do [ 10001 ] | In Progress [ 3 ] |
| Description | The base package does not have a readme file, so it's unclear what it's for. The package name is also somewhat unfortunate, being so generic, but at least with a readme it would be clearer how important it is (if it is, in fact, important). |
-The base package does not have a readme file, so it's unclear what it's for. The package name is also somewhat unfortunate, being so generic, but at least with a readme it would be clearer how important it is (if it is, in fact, important).-
The {{README.rst}} for the {{base}} package is not compliant with the [current recommended cookie cutter package README file|https://github.com/lsst/templates/blob/master/project_templates/stack_package/%7B%7Bcookiecutter.package_name%7D%7D/README.rst]. This ticket updates base to that standard. |
| Description |
-The base package does not have a readme file, so it's unclear what it's for. The package name is also somewhat unfortunate, being so generic, but at least with a readme it would be clearer how important it is (if it is, in fact, important).-
The {{README.rst}} for the {{base}} package is not compliant with the [current recommended cookie cutter package README file|https://github.com/lsst/templates/blob/master/project_templates/stack_package/%7B%7Bcookiecutter.package_name%7D%7D/README.rst]. This ticket updates base to that standard. |
-The base package does not have a readme file, so it's unclear what it's for. The package name is also somewhat unfortunate, being so generic, but at least with a readme it would be clearer how important it is (if it is, in fact, important).-
The {{README.rst}} for the {{base}} package is not compliant with the [current recommended cookie cutter package README file|https://github.com/lsst/templates/blob/master/project_templates/stack_package/%7B%7Bcookiecutter.package_name%7D%7D/README.rst]. This ticket updates the base {{README.rst}} to that standard. |
| Assignee | Lee Kelvin [ lskelvin ] |
| Reviewers | Tim Jenness [ tjenness ] | |
| Status | In Progress [ 3 ] | In Review [ 10004 ] |
| Status | In Review [ 10004 ] | Reviewed [ 10101 ] |
| Team | SQuaRE [ 10302 ] | Data Release Production [ 10301 ] |
| Resolution | Done [ 10000 ] | |
| Status | Reviewed [ 10101 ] | Done [ 10002 ] |
| Epic Link |
|
|
| Urgent? | off |