Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-53081

Review and improve the txt files in the moodle.git root

    XMLWordPrintable

    Details

    • Type: New Feature
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 3.1
    • Fix Version/s: 3.1
    • Component/s: Documentation, Licensing, Other
    • Labels:
    • Testing Instructions:
      Hide

      This can be really tested only after it is integrated and released.

      • Check that README.txt is displayed on the main page of the Moodle github page.
      • Check that a link to CONTRIBUTING.txt is displayed when one tries to fill a pull request at Github.
      • Check that when opening a pull request at github, the template contents is used to pre-fill the pull request message with a warning of not doing that.
      Show
      This can be really tested only after it is integrated and released. Check that README.txt is displayed on the main page of the Moodle github page. Check that a link to CONTRIBUTING.txt is displayed when one tries to fill a pull request at Github. Check that when opening a pull request at github, the template contents is used to pre-fill the pull request message with a warning of not doing that.
    • Affected Branches:
      MOODLE_31_STABLE
    • Fixed Branches:
      MOODLE_31_STABLE
    • Pull from Repository:
    • Pull Master Branch:
      MDL-53081-master-txtfiles
    • Pull Master Diff URL:

      Description

      In MDLSITE-3691 it was agreed that having a file CONTRIBUTING would be nice to have for Moodle. It also seems to be a good opportunity for review, re-organisation and improvements of the txt files there:

      • README.txt - to make a quick overview of the Moodle and other sources
      • INSTALL.txt - quick summary of how to install Moodle
      • COPYING.txt - common GPL v3
      • CONTRIBUTING.txt - ways to contribute with links for further information
      • TRADEMARK.txt - information about the Moodle trademark
      • PULL_REQUEST_TEMPLATE.txt - yet another way to try and prevent pull requests at github

        Attachments

        1. Screenshot_2016-02-12_11-30-09.png
          70 kB
          David Mudrák (@mudrd8mz)
        2. Screenshot_2016-02-18_12-04-01.png
          64 kB
          David Mudrák (@mudrd8mz)

          Issue Links

          will help resolve

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. MDLSITE-3691 Reorganize a good number of key pages of the dev docs

          • Minor - Minor loss of function where workaround is possible
          • Project Definition

          New Feature - A new Moodle feature which has yet to be developed. MDLSITE-3684 Dealing with open pull requests on github

          • Minor - Minor loss of function where workaround is possible
          • Open

            Activity

              People

              • Votes:
                0 Vote for this issue
                Watchers:
                7 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:
                  Fix Release Date:
                  23/May/16