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

Develop README, CONTRIBUTING templates for stack packages

    XMLWordPrintable

    Details

      Description

      In conjunction with deploying a Sphinx-based stack documentation system, we should not neglect the other types of documentation in GitHub repos. This ticket will develop templates/systems for the following, leading to an RFC:

        Attachments

          Issue Links

          duplicates

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-4619 Add README, CONTRIBUTING and GitHub summaries to each package

          • Won't Fix
          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-11513 Prototype system for publishing templates of package documentation

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-7198 Document template for EUPS Stack packages in developer guide

          • Invalid
          mentioned in

          Page Loading...

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            With DM-11513, and RFC-376, this ticket can proceed in the lsst/templates repository.

            Show
            jsick Jonathan Sick added a comment - With DM-11513 , and RFC-376 , this ticket can proceed in the lsst/templates repository.
            Hide
            Permalink
            tjenness Tim Jenness added a comment -

            Jonathan Sick what's the status of this ticket?

            Show
            tjenness Tim Jenness added a comment - Jonathan Sick what's the status of this ticket?
            Hide
            Permalink
            ktl Kian-Tat Lim added a comment -

            README.rst is part of the cookiecutter template.  CONTRIBUTING is part of a standard package's doc.  We have only just begun to try out PR templates.  I'd say this is basically done.

             

            Show
            ktl Kian-Tat Lim added a comment - README.rst is part of the cookiecutter template.  CONTRIBUTING is part of a standard package's doc.  We have only just begun to try out PR templates.  I'd say this is basically done.  
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            I'll mark this as "won't fix". We can create a new ticket to specifically enhance the README, CONTRIBUTING, etc files in the package template.

            Show
            jsick Jonathan Sick added a comment - I'll mark this as "won't fix". We can create a new ticket to specifically enhance the README, CONTRIBUTING, etc files in the package template.

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Watchers:
              John Parejko, Jonathan Sick, Kian-Tat Lim, Krzysztof Findeisen, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.