Everyone can take a part in making our product better, it can be done by submitting bug ticket or enhancement ticket, and best what can be done – submitting new pull request with changes that makes usage of product more efficient, add some feature or fix some reported bug. Following next instructions make us much easy (and faster as well) fix submitted issue or review and include pull request.
- Submit a ticket for your issue, assuming one does not already exist.
- Clearly describe the issue including steps to reproduce when it is a bug, if it possible include code examples and screenshots.
- Make sure you fill in the earliest version that you know has the issue.
- If you feel yourself strong enough to implement fix - fork the repository on GitHub, and follow Making Changes to provide fix/update and pull it to product.
It is easy to make changes, and test them as well. If you need some instructions about build this module – please take a look to How to build.
- Create a topic branch from where you want to base your work.
- This is usually the master branch.
- Only target release branches if you are certain your fix must be on that branch.
- To quickly create a topic branch based on main;
git checkout -b fix_my_contribution main. Please avoid working directly on themainbranch.
- Make commits of logical units using Commit message conventions.
- Check for unnecessary whitespace with
git diff --checkbefore committing. - Make sure your commit messages are in the proper format.
- Make sure you have added the necessary tests for your changes, they can be written with groovy or java – as you like.
- Run all the tests to assure nothing else was accidentally broken, for instructions additional instructions about build take a look to How to build.
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request to the repository, please follow Pull Request Template, it makes much easy to review updates and test them.
- If automatic build enabled - you will find some status of testing this pull request.
- After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.
Commit messages are used to generate the release notes for each release. To do this, we loosely follow the AngularJS commit conventions: for commit messages to appear in the release notes, the title line needs to respect the following format:
<type>: <message>
examples:
chore: upgrade plugin
fix: report statistics
where is one of the following:
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- refactor: A code change that neither fixes a bug or adds a feature
- perf: A code change that improves performance
- test: Adding missing tests
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
Also commits can consists of several lines - to include some additional information in release notes. For example:
feat: A new feature to make something better
now it will be available to call api.function() with additional parameters like api.function(Integer)
it will be included in release notes as:
-
feat: A new feature to make something better
now it will be available to call api.function() with additional parameters like api.function(Integer)
Please take a look at release notes to find some more examples of multiline commits.
Starting from version 1.1.26, any commits without one of these prefixes will not appear in the release notes.
During creating pull request please use name conventions and short template for description.
If Pull request related to some issue, or issues – name of it should starts from reference, like #241 for example. If no issues for this pull request just short title. Here is some examples for pull requests names:
Included test execution duration for #124
some:lib was updated to 2.45 for #435
Updated structure of configuration to for retries
Remember almost all pull requests will be included in release notes, so name of pull requests is very important
PR body Template:
#### Summary of this PR
What does this pull request do in general terms?
Does it fix something, add some feature or just change code style, etc. ?
#### Intended effect
What is the expected effect of the pull request?
Specifically, indicate how the behavior will be different than before the pull request.
#### How should this be manually tested?
How can reviewers verify the request has the intended effect?
How it can be tested, can it be tested using serenity-demos project or some other repos?
#### Side effects
Does the pull request contain any side effects?
This should list non-obvious things that have changed in the request.
#### Documentation
If the pull request is user facing, how is it documented?
Are there examples of how to use the new behavior that users need to know about?
#### Relevant tickets
List of tickets, that are fixed or somehow related to this PR
#### Screenshots (if appropriate)
If this PR change something, that can change view of report or console output, etc – please include
screenshots “what was before this PR” and how it will be changed”.
Serenity BDD is built with Maven, using Maven Wrapper to achieve consistent builds for all developers. Ensure that JDK 17 is installed and configured as the default JDK. After cloning the repository navigate to the project root directory and execute:
./mvnw clean verify
The build takes a few minutes. A lot of tests should execute before build can be marked successful.
To check a change locally without running the full test suite build the snapshot version like this:
./mvnw clean install -DskipTests