jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-14 11:03:09 +02:00
Code Issues Releases Activity

Merge pull request #297 from marcusholl/pr/returnTypeVoid

Browse Source 
Pipeline steps are expected not to return a return value
This commit is contained in:
Marcus Holl 2018-09-21 13:48:33 +02:00 committed by GitHub
commit c63e6e88c0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/CONTRIBUTING.md vendored
View File

@ -25,6 +25,10 @@ All pipeline library coding _must_ come with automated unit tests.
The contract of functionality exposed by a library functionality needs to be documented, so it can be properly used.
Implementation of a functionality and its documentation shall happen within the same commit(s).
### Coding pattern
Pipeline steps must not make use of return values. The pattern for sharing parameters between pipeline steps or between a pipeline step and a pipeline script is sharing values via the [`commonPipelineEnvironment`](../vars/commonPipelineEnvironment.groovy). Since there is no return value from a pipeline step the return value of a pipeline step is already `void` rather than `def`.
### Code Style
The code should follow any stylistic and architectural guidelines prescribed by the project. In the absence of guidelines, mimic the styles and patterns in the existing code-base.