CONTRIBUTING.md

   1 # Contributing to Moodle
   2
   3 [Moodle][1] is made by people like you. We are members of a big worldwide community of developers, designers, teachers, testers, translators and many more. We work in universities, schools, companies and other places. You are very welcome to join us and contribute to the project.
   4
   5 There are many ways that you can contribute to Moodle, not just through development. See our [community contribution guide][2] for some of the many ways that you can help.
   6
   7 ## Github
   8
   9 > [!NOTE]
  10 > Please do not open pull requests via Github.
  11
  12 All issues should be reported via, and patched provided to the [Moodle Tracker][3].
  13
  14 The Moodle [Github][4] repository is a clone of the official Moodle repository, whcih can be found at https://git.moodle.org.
  15
  16 ## Moodle core bug fixes and new features
  17
  18 Over the years, Moodle has developed a mature process for reporting, reviewing, and accepting patches. This is fully documented in our [documentation on  development processes][6], but in summary:
  19
  20 - Every bug fix or new feature must have a tracker issue.
  21 - You publish the branch implementing the fix or new feature in your public clone of the moodle.git repository (typically on Github).
  22 - Your patch is peer-reviewed, discussed, integrated, tested and then released as a part of one of our weekly releases.
  23 - New features are developed on the `main` branch. Bug fixes are also backported to currently supported maintenance (stable) branches.
  24
  25 > [!IMPORTANT]
  26 > Please do not publish security issues, or patches releating to them publicly.
  27 > See our [Responsible Disclosure Policy][5] for more information.
  28
  29
  30 ## Moodle plugins
  31
  32 Moodle has a framework for additional plugins to extend its functionality. We
  33 have a Moodle plugins directory <https://moodle.org/plugins/> where you can
  34 register and maintain your plugin. Plugins hosted in the plugins directory can
  35 be easily installed and updated via the Moodle administration interface.
  36
  37 * You are expected to have a public source code repository with your plugin
  38   code.
  39 * After registering your plugin in the plugins directory it is reviewed before
  40   being published.
  41 * You are expected to continuously release updated versions of the plugin via
  42   the plugins directory. We do not pull from your code repository; you must do
  43   it explicitly.
  44
  45 For further details, see <https://moodledev.io/general/community/plugincontribution>.
  46
  47 [1]: https://moodle.org
  48 [2]: https://moodledev.io/general/community/contribute
  49 [3]: https://tracker.moodle.org
  50 [4]: https://github.com/moodle/moodle
  51 [5]: https://moodledev.io/general/development/process/security
  52 [6]: https://moodledev.io/general/development/process