Skip to content

Commit

Permalink
docs: Add contributors guide (#75)
Browse files Browse the repository at this point in the history
* docs: Add contributors guide

* Fix enumeration

* Add emphasis

* Add PR template

* Wording

* Wording
  • Loading branch information
amannn authored Jan 14, 2021
1 parent c8c1d3e commit 054c977
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!--
Thank you very much for contributing to this project!
Please make sure to have a look at the [contributors guide](https://github.com/amannn/action-semantic-pull-request/blob/master/CONTRIBUTORS.md) so you can test your changes.
For any non-trivial changes, please include a link to a workflow where you tested the current state of this pull request (see contributors guide).
-->
16 changes: 16 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Contributors

Thank you very much for contributing to this project!

Due to the way event triggers work with GitHub actions it's a bit harder to test your changes.

Simple changes that can be unit tested can be implemented with the regular workflow where you fork the repo and create a pull request. Note however that the new version of the action won't be executed in the workflows of this repository. We have to rely on the unit tests in this case.

If e.g. environment parameters are changed, the action should be tested end-to-end in a workflow.

To do this, please follow this process:

1. Fork the repo.
2. Create a PR in **your own repo**.
3. The "Lint PR title preview (current branch)" workflow will run the new version and will help you validate the change.
4. Create a PR to this repo with the changes. In this case the preview workflow will fail, but we'll know that it works since you tested it in the fork. Please include a include a link to a workflow where you tested the current state of this pull request.

0 comments on commit 054c977

Please sign in to comment.