diff --git a/docs/contributors.md b/docs/contributors.md index 7719dda..29cceba 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -25,3 +25,7 @@ During the commit step, Husky will take care of formatting all files with [Prett ### Testing We ask that you include a link to a succesfull run that utilizes the changes you are working on. For example, if your changes are in the branch `newAwesomeFeature`, then show an example run that uses `setup-python@newAwesomeFeature` or `my-fork@newAwesomeFeature`. This will help speed up testing and help us confirm that there are no breaking changes or bugs. + +### Releases + +There is a `master` branch where contributor changes are merged into. There are also release branches such as `releases/v1` that are used for tagging (for example the `v1` tag) and publishing new versions of the action. Changes from `master` are periodically merged into a releases branch. You do not need to create any PR that merges changes from master into a releases branch.