Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

63 lines (43 loc) · 2.53 KB

Contributing to Better-Moodle

Thanks for reading this contribution guide! 😊

Note

This guide is currently still work in progress. Expect changes, especially clarifications to appear here in the future.

Tip

Anything unclear? Feel free to ask @jxn-30 for clarification!

Development

Contribution Workflow

Some steps are

  1. clone
  2. run yarn install
  3. develop and test
  4. run yarn run lint:fix and yarn run prettier:write to lint and format. See section Pre-Commit
    1. fix any warnings and errors reported by ESLint
  5. commit using Conventional Commits. See section Commit messages for more info.
  6. Create a Pull-Request

Pre-Commit

The package.json of Better-Moodle includes scripts for formatting (prettier:write) and linting (lint:fix), the Better-Moodle repository also includes an up-to-date release of Yarn package manager. Please run both scripts with yarn (yarn run lint:fix and yarn run prettier:write) before committing and also fix any warnings and issues reported by ESLint.

Commit messages

Better-Moodle uses Conventional Commits in its latest version, which is 1.0.0 at the time of writing. This ensures that Release Please can generate the changelog. Release Please introduces some additional features such as commit messages that allow to document multiple changes within a single commit. Please review the docs of Release Please for more information on how to use them.

The use of the Release-As-Directive of Release Please is discouraged for use in Better-Moodle main repository.

Pull-Requests

Your Pull Request should have a meaningful title as well as a content describing the changes introduced by this PR. There currently is no Pull Request Template available for Better-Moodle.

Changelog

Please do not manually edit the CHANGELOG.md file as the Changelog is generated by Release Please

Testing

There currently are no automated tests available. Please always make sure that Better-Moodle works on latest 3 to 4 versions of common browsers (Firefox and chromium based). You may also want to test Better-Moodle on mobile devices if possible.