Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-4875

Give base an updated readme file

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: base
    • Labels:
      None

      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

            Activity

            Parejkoj John Parejko created issue -
            Parejkoj John Parejko made changes -
            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 ]
            swinbank John Swinbank made changes -
            Team SQuaRE [ 10302 ]
            Parejkoj John Parejko made changes -
            Link This issue relates to RFC-552 [ RFC-552 ]
            lskelvin Lee Kelvin made changes -
            Summary base has no readme Give base an updated readme file
            lskelvin Lee Kelvin made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            lskelvin Lee Kelvin made changes -
            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.
            lskelvin Lee Kelvin made changes -
            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.
            lskelvin Lee Kelvin made changes -
            Assignee Lee Kelvin [ lskelvin ]
            lskelvin Lee Kelvin made changes -
            Reviewers Tim Jenness [ tjenness ]
            Status In Progress [ 3 ] In Review [ 10004 ]
            tjenness Tim Jenness made changes -
            Status In Review [ 10004 ] Reviewed [ 10101 ]
            lskelvin Lee Kelvin made changes -
            Team SQuaRE [ 10302 ] Data Release Production [ 10301 ]
            lskelvin Lee Kelvin made changes -
            Resolution Done [ 10000 ]
            Status Reviewed [ 10101 ] Done [ 10002 ]
            yusra Yusra AlSayyad made changes -
            Epic Link DM-27974 [ 442759 ]
            Urgent? off

              People

              Assignee:
              lskelvin Lee Kelvin
              Reporter:
              Parejkoj John Parejko
              Reviewers:
              Tim Jenness
              Watchers:
              John Parejko, Lee Kelvin, Russell Owen, Simon Krughoff, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.