Skip to content
This repository was archived by the owner on Nov 23, 2021. It is now read-only.

Commit b637101

Browse files
committed
docs: updating contributing docs
1 parent 8993eba commit b637101

File tree

1 file changed

+24
-7
lines changed

1 file changed

+24
-7
lines changed

CONTRIBUTING.md

+24-7
Original file line numberDiff line numberDiff line change
@@ -48,18 +48,35 @@ where <type> is one of the following:
4848
- perf: A code change that improves performance
4949
- test: Adding missing tests
5050
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
51-
Starting from version 1.0.24, any commits without one of these prefixes will not appear in the release notes.
51+
52+
Also commits can consists of several lines - to include some additional information in relase notes. For example:
53+
```
54+
feat: A new feature to make something better
55+
now it will be available to call api.function() with additional parameters like api.function(Integer)
56+
```
57+
it will be included in release notes as:
58+
59+
- feat: A new feature to make something better
60+
61+
> now it will be available to call api.function() with additional parameters like api.function(Integer)
62+
63+
Please take a look at release notes to find some more examples of mutiline commits.
64+
65+
Starting from version 1.1.26, any commits without one of these prefixes will not appear in the release notes.
5266

5367
## <a name="pull_request_template"></a> Pull Request Template
5468
During creating pull request please use name conventions and short template for description.
5569

5670
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:
5771
```
58-
#124 Including test execution duration
59-
#435 Updating dependency
60-
Updating structure of configuration
72+
Included test execution duration for #124
73+
some:lib was updated to 2.45 for #435
74+
Updated structure of configuration to for retries
6175
```
62-
PR Template:
76+
**Remember**
77+
almost all pull requests will be included in release notes, so name of pull requests is very important
78+
79+
PR body Template:
6380

6481
```
6582
#### Summary of this PR
@@ -121,6 +138,6 @@ this command will run chromedriver as server and if output does not contains err
121138
For builds we use [gradle](http://gradle.org), and to achive that all developers will use same version - [wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) is configured.
122139
So, now you are redy to build module. After you checkout it go to folder and execute:
123140
```
124-
./gradlew clean test install
141+
./gradlew clean test integrationTests install
125142
```
126-
It will take some time... A lot of tests should execute before build can be marked successfull. Using gradle documenation you can configure executing only your tests.
143+
It will take some time... A lot of tests should execute before build can be marked successfull. Using gradle documenation you can configure executing only your tests.

0 commit comments

Comments
 (0)