Contributing

Issues

For new feature requests or bugs found, open a new issue for Selenified. Be sure to include as much detail as possible, screenshots, implementation details, expected results, etc. Someone on the dev team will reach out if questions exist. If this is impacting your work, please indicate some sort of priority or impact to your team, and our devs will take this into account for prioritizing the fix, and performing the release (potentially earlier than usual). Once the fix is implemented, expect to be contacted for an informal review to ensure your feature has been properly resolved.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Request Process

1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
3. Ensure javadocs are provided for all public methods, as these are publicly hosted and used at github.io
4. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
5. You may merge the Pull Request in once you have the sign-off of any other developers, and SonarQube and Jenkins build returns cleanly. If you do not have permission to do that, you may request the reviewer to merge it for you.

More information can be found on the workflow wiki page

Forking

If you are interested in using Selenified outside of the official releases, feel free to roll your own instance. You can fork the repository, make whatever changes you desire, and then follow the build decisions. If you want to run your own branching/merge strategy, ensure your base repository is set to your own repo, otherwise those changes will also be requested in the official Selenified repository.

If the changes are generic, and you feel should be included in Selenified, please open a PR from your fork back into our repository, we're happy to include changes that help out the community.