Skip to content

Commit

Permalink
Mention GitHub Actions CI in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
olleolleolle authored Nov 13, 2020
1 parent 08f2b91 commit 4dd0428
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,31 +13,30 @@ problems and make sure they don't come back.

So if you can reproduce your problem in a spec, that would be awesome! If you can't, please
let us know how we can make this easier for you. Also, provide code and the WSDL of the
service you're working with so others can try to come up with a spec for your problem.
service you're working with, so others can try to come up with a spec for your problem.

After we have a failing spec, it obviously needs to be fixed. Make sure your new spec is the
only failing one under the `spec` directory. Travis only runs the "unit tests" at `spec/savon`,
After we have a failing spec, it needs to be fixed. Make sure your new spec is the
only failing one under the `spec` directory. CI only runs the "unit tests" at `spec/savon`,
but Savon actually has some additional specs at `spec/integration`, which you need to run locally
to make sure the integration with real world services still works.
to make sure the integration with real-world services still works.

These specs are not run by Travis, because the services are not guaranteed to work all the time.
These specs are not run by CI, because the services are not guaranteed to work all the time.

Please follow this basic workflow for pull requests:
Please follow this workflow for Pull Requests:

* [Fork the project](https://help.github.com/articles/fork-a-repo)
* Create a feature branch and make your bug fix
* Add tests for it!
* [Send a pull request](https://help.github.com/articles/using-pull-requests)
* [Check that your pull request passes the build](https://travis-ci.org/savonrb/savon/pull_requests)

* [Send a Pull Request](https://help.github.com/articles/using-pull-requests)
* [Check that your Pull Request passes the build](https://github.com/savonrb/savon/actions?query=workflow%3ARuby)

**Improvements and feature requests**

If you have an idea for an improvement or a new feature, please feel free to
[create a new issue](https://github.com/savonrb/savon/issues/new/choose) and describe your idea
[create a new Issue](https://github.com/savonrb/savon/issues/new/choose) and describe your idea
so that other people can give their insights and opinions. This is also important to avoid
duplicate work.

Pull requests and issues on GitHub are meant to be used to discuss problems and ideas,
Pull Requests and Issues on GitHub are meant to be used to discuss problems and ideas,
so please make sure to participate and follow up on questions. In case no one comments
on your ticket, please keep updating the ticket with additional information.

0 comments on commit 4dd0428

Please sign in to comment.