kotovalexarian-likes-github/thoughtbot--shoulda-matchers
1
0
Fork 0
mirror of https://github.com/thoughtbot/shoulda-matchers.git synced 2022-11-09 12:01:38 -05:00
Code Releases Activity

Update the contributing guide about GitHub Actions (#1477)

Browse source 
- Change links from Travis CI to GitHub Actions
- Add an explanation about first-time contributors needing approval
This commit is contained in:
Neilson Carvalho 2022-01-19 14:25:02 -03:00 committed by GitHub
parent 2410164308
commit 4eb5bb0b35
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
CONTRIBUTING.md
View file

@ -20,8 +20,8 @@ you think would be useful? Here's what you need to do:
API](#documentation).
1. [Refrain from updating the changelog.](#a-word-on-the-changelog)
1. Push to your fork and submit a pull request.
1. [Ensure that the test suite passes on Travis and make any necessary changes
to your branch to bring it to green.](#continuous-integration)
1. [Ensure that the test suite passes on GitHub Actions and make any necessary
changes to your branch to bring it to green.](#continuous-integration)
Although we maintain Shoulda Matchers in our free time, we try to respond to
contributions in a timely manner. Once we look at your pull request, we may give
@ -199,16 +199,17 @@ your branch, but don't worry about this — we'll take care of it!
While running `bundle exec rake` is a great way to check your work, this command
will only run your tests against the latest supported Ruby and Rails version.
Ultimately, though, you'll want to ensure that your changes work in all possible
environments. We make use of [Travis][travis] to do this work for us. Travis
will kick in after you push up a branch or open a PR. It takes 20-30 minutes to
run a complete build, which you are free to
[monitor as it progresses][shoulda-matchers-on-travis].
environments. We make use of [GitHub Actions][gh-actions] to do this work for
us. GitHub Actions will kick in after you push up a branch or open a PR.
It takes 20-30 minutes to run a complete build, which you are free to
[monitor as it progresses][shoulda-matchers-on-gh-actions]. First-time
contributors may need to wait until a maintainer approves the build.
[shoulda-matchers-on-travis]: https://travis-ci.org/thoughtbot/shoulda-matchers
[shoulda-matchers-on-gh-actions]: https://github.com/thoughtbot/shoulda-matchers/actions
What happens if the build fails in some way? Don't fear! Click on a failed job
and scroll through its output to determine the cause of the failure. You'll want
to make changes to your branch and push them up until the entire build is green.
It may take a bit of time, but overall it is worth it and it helps us immensely!
[travis]: https://travis-ci.org/
[gh-actions]: https://github.com/features/actions