Skip to content

Commit 27cdbc8

Browse files
Merge pull request #284 from IBM/release/0.5.0
Release/0.5.0
2 parents 6132be6 + 3d96c45 commit 27cdbc8

File tree

136 files changed

+2736
-3418
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

136 files changed

+2736
-3418
lines changed

CONTRIBUTING.md

Lines changed: 94 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,107 @@
22
# Contribution Guidelines
33
The contribution guidelines in this document pertain to contributing to this zowe-cli-cics-deploy-plugin repository.
44

5-
This project welcomes all contributions.
6-
- If you find a bug or would like to suggest an improvement, please raise an issue.
7-
- If you would like to contribute a bug fix or small enhancement, please fork the repo and make a pull request.
8-
- If you would like to contribute a new feature, please raise an issue describing your proposal so we can discuss it first.
5+
We welcome bug reports and discussions about new function in the issue tracker, and we also welcome proposed new features or bug fixes via pull requests.
96

10-
## Developing Zowe CLI plugins
7+
You should read these guidelines to help you contribute.
8+
9+
## Reporting a bug
10+
11+
Please raise bugs via the issue tracker. First, check whether an issue for your problem already exists.
12+
13+
When raising bugs, try to give a good indication of the exact circumstances that provoked the bug. What were you doing? What did you expect to happen? What actually happened? What logs or other material can you provide to show the problem?
14+
15+
## Requesting new features
16+
17+
Please request new features via the issue tracker. When requesting features, try to show why you want the feature you're requesting.
18+
19+
## Contributing code
20+
21+
### Before you start...
22+
23+
If you're thinking of fixing a bug or adding new features, be sure to open an issue first. This gives us a place to have a discussion about the work.
24+
25+
### Licensing
26+
27+
All code must have an EPL v2.0 header. Please add the following to any new files you create:
28+
```
29+
/*
30+
* This program and the accompanying materials are made available under the terms of the
31+
* Eclipse Public License v2.0 which accompanies this distribution, and is available at
32+
* https://www.eclipse.org/legal/epl-v20.html
33+
*
34+
* SPDX-License-Identifier: EPL-2.0
35+
*
36+
*/
37+
```
38+
39+
### Signing your contribution
40+
41+
You must declare that you wrote the code that you contribute, or that you have the right to contribute someone else's code. To do so, you must sign the [Developer Certificate of Origin](https://developercertificate.org) (DCO):
42+
43+
```
44+
Developer Certificate of Origin
45+
Version 1.1
46+
47+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
48+
1 Letterman Drive
49+
Suite D4700
50+
San Francisco, CA, 94129
51+
52+
Everyone is permitted to copy and distribute verbatim copies of this
53+
license document, but changing it is not allowed.
54+
55+
56+
Developer's Certificate of Origin 1.1
57+
58+
By making a contribution to this project, I certify that:
59+
60+
(a) The contribution was created in whole or in part by me and I
61+
have the right to submit it under the open source license
62+
indicated in the file; or
63+
64+
(b) The contribution is based upon previous work that, to the best
65+
of my knowledge, is covered under an appropriate open source
66+
license and I have the right under that license to submit that
67+
work with modifications, whether created in whole or in part
68+
by me, under the same open source license (unless I am
69+
permitted to submit under a different license), as indicated
70+
in the file; or
71+
72+
(c) The contribution was provided directly to me by some other
73+
person who certified (a), (b) or (c) and I have not modified
74+
it.
75+
76+
(d) I understand and agree that this project and the contribution
77+
are public and that a record of the contribution (including all
78+
personal information I submit with it, including my sign-off) is
79+
maintained indefinitely and may be redistributed consistent with
80+
this project or the open source license(s) involved.
81+
```
82+
83+
84+
If you can certify the above, then sign off each Git commit at the bottom of the commit message with the following:
85+
86+
```
87+
Signed-off-by: My Name <[email protected]>
88+
```
89+
90+
You must use your real name and email address.
91+
92+
To save you having to type the above for every commit, Git can add the `Signed-off-by` line. When committing, add the `-s` option to your `git commit` command.
93+
94+
If you haven't signed each commit, then the pull request will fail to pass all checks.
95+
96+
97+
## Developing Zowe CLI plug-ins
1198

1299
For guidelines on developing Zowe CLI plug-ins see the [Zowe CLI GitHub repository](https://github.com/zowe/zowe-cli). The following information is critical to working with the code, running/writing/maintaining automated tests, developing consistent syntax and ensuring that the plug-in integrates with Zowe CLI properly:
13100

14101
| For more information about ... | See: |
15102
| ------------------------------ | ----- |
16-
| General guidelines that apply to contributing to Zowe CLI and Plug-ins | [Contribution Guidelines](https://github.com/zowe/zowe-cli/blob/master/CONTRIBUTING.md) |
103+
| General guidelines that apply to contributing to Zowe CLI and plug-ins | [Contribution Guidelines](https://github.com/zowe/zowe-cli/blob/master/CONTRIBUTING.md) |
17104
| Conventions and best practices for creating packages and plug-ins for Zowe CLI | [Package and Plug-in Guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/PackagesAndPluginGuidelines.md)|
18105
| Guidelines for running tests on Zowe CLI | [Testing Guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/TESTING.md) |
19106
| Guidelines for running tests on the plug-ins that you build for Zowe CLI | [Plug-in Testing Guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/PluginTESTINGGuidelines.md) |
20107
| Documentation that describes the features of the Imperative CLI Framework | [About Imperative CLI Framework](https://github.com/zowe/imperative/wiki) |
21-
Versioning conventions for Zowe CLI and Plug-ins| [Versioning Guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/MaintainerVersioning.md) |
108+
Versioning conventions for Zowe CLI and plug-ins| [Versioning Guidelines](https://github.com/zowe/zowe-cli/blob/master/docs/MaintainerVersioning.md) |

0 commit comments

Comments
 (0)