CONTRIBUTING.txt

   1 CONTRIBUTING TO MOODLE
   2 ======================
   3
   4 Moodle is made by people like you. We are members of a big worldwide community
   5 of developers, designers, teachers, testers, translators and other users. We
   6 work in universities, schools, companies and other places. You are very welcome
   7 to join us and contribute to the project.
   8
   9 See <https://docs.moodle.org/dev/Contributing_to_Moodle> for the many ways you
  10 can help, not only with coding.
  11
  12 Moodle is open to community contributions to core, though all code must go
  13 through peer-review, automated behaviour testing, continuous integration and
  14 human post-integration checks.
  15
  16 Pull requests
  17 -------------
  18
  19 Please do not open pull requests via Github. The repository there is just a
  20 mirror of the official repository at <https://git.moodle.org>. Issues are
  21 reported and patches provided via <https://tracker.moodle.org>. See below for
  22 more information.
  23
  24 Moodle core bug fixes and new features
  25 --------------------------------------
  26
  27 During the years of intensive development, a mature process of including
  28 submitted patches has evolved.
  29
  30 * Every bug fix or new feature must have a tracker issue.
  31 * You publish the branch implementing the fix or new feature in your public
  32   clone of the moodle.git repository (typically on Github).
  33 * Your patch is peer-reviewed, discussed, integrated, tested and then released
  34   as a part of moodle.git.
  35 * New features are developed on the master branch. Bug fixes are also
  36   backported to currently supported maintenance (stable) branches.
  37
  38 For further details, see <https://docs.moodle.org/dev/Process>.
  39
  40 Moodle plugins
  41 --------------
  42
  43 Moodle has a framework for additional plugins to extend its functionality. We
  44 have a Moodle plugins directory <https://moodle.org/plugins/> where you can
  45 register and maintain your plugin. Plugins hosted in the plugins directory can
  46 be easily installed and updated via the Moodle administration interface.
  47
  48 * You are expected to have a public source code repository with your plugin
  49   code.
  50 * After registering your plugin in the plugins directory it is reviewed before
  51   being published.
  52 * You are expected to continuously release updated versions of the plugin via
  53   the plugins directory. We do not pull from your code repository; you must do
  54   it explicitly.
  55
  56 For further details, see <https://docs.moodle.org/dev/Plugin_contribution>.