Add CONTRIBUTING docs, e.g. with steps on how to test out changes made

catalyst / catalyst-moodle-workflows

4 stars 8 forks source link

Add CONTRIBUTING docs, e.g. with steps on how to test out changes made #39

Open keevan opened 2 years ago

keevan commented 2 years ago

Options:

remote testing (e.g branch and everything is branched referenced
local testing using something like act

keevan commented 2 years ago

For pull requests and regarding changes to the workflows, there should also be documentation on how one can test and review the changes, detailing what would be involved to help streamline the review process.

At a minimum there should be a plugin referencing the workflow branch to demonstrate the changes made.