This page describes how to contribute changes to Akami.
Please do not create a pull request without reading this guide first.
Bug fixes
Akami builds WS-Security (wsse) headers for SOAP requests. If you think you found a bug,
the most useful input you can give us is: how you configured the Akami::WSSE object (the
credentials, timestamp, or signature options you set), the XML you got back from to_xml,
and the XML you expected. You're a developer, we are developers, and you know we need a
test to reproduce a problem and make sure it does not come back.
So if you can reproduce your problem in a spec, that would be awesome! Please include the
options you set, because the header output depends on them (credentials, timestamp,
created_at, expires_at, sign_with, and friends).
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.
Running tests
bundle install
bundle exec rspecBefore opening a pull request, also run the checks CI runs so you don't get a red build:
bundle exec standardrbPlease follow this workflow for Pull Requests:
- Fork the project
- Create a feature branch and make your bug fix
- Add tests for it!
- Send a Pull Request
- Check that your Pull Request passes the build
Improvements and feature requests
If you have an idea for an improvement or a new feature, please feel free to create a new Issue 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, 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.