Skip to content

Commit 16520fd

Browse files
Add Contributing and License sections in README (#16)
Signed-off-by: Mu Chen <[email protected]>
1 parent d4f8883 commit 16520fd

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,3 +136,35 @@ tls_server_config:
136136
* [IBM Spectrum Virtualize RESTful API For FS9xxx](https://www.ibm.com/support/knowledgecenter/en/STSLR9_8.2.0/com.ibm.fs9100_820.doc/rest_api_overview.html)
137137

138138
* [IBM Spectrum Virtualize Interfacing Using the RESTful API](https://www.ibm.com/support/knowledgecenter/STVLF4_8.1.3/spectrum.virtualize.813.doc/Spectrum_Virtualize_API_8.1.3.pdf)
139+
140+
## Contributing
141+
142+
Third party contributions to this project are welcome!
143+
144+
In order to contribute, create a [Git pull request](https://help.github.com/articles/using-pull-requests/), considering this:
145+
146+
* Test is required.
147+
* Each commit should only contain one "logical" change.
148+
* A "logical" change should be put into one commit, and not split over multiple
149+
commits.
150+
* Large new features should be split into stages.
151+
* The commit message should not only summarize what you have done, but explain
152+
why the change is useful.
153+
* The commit message must follow the format explained below.
154+
155+
What comprises a "logical" change is subject to sound judgement. Sometimes, it
156+
makes sense to produce a set of commits for a feature (even if not large).
157+
For example, a first commit may introduce a (presumably) compatible API change
158+
without exploitation of that feature. With only this commit applied, it should
159+
be demonstrable that everything is still working as before. The next commit may
160+
be the exploitation of the feature in other components.
161+
162+
For further discussion of good and bad practices regarding commits, see:
163+
164+
* [OpenStack Git Commit Good Practice](https://wiki.openstack.org/wiki/GitCommitMessages)
165+
166+
* [How to Get Your Change Into the Linux Kernel](https://www.kernel.org/doc/Documentation/process/submitting-patches.rst)
167+
168+
## License
169+
170+
The spectrum-virtualize-exporter is licensed under the [Apache 2.0 License](https://github.com/IBM/spectrum-virtualize-exporter/blob/master/LICENSE).

0 commit comments

Comments
 (0)