From a89e8bdc8a3c9b038ab0a85a8014f2590914062b Mon Sep 17 00:00:00 2001 From: Leo Christy Jesuraj Date: Sun, 13 Apr 2025 18:02:15 -0400 Subject: [PATCH 1/2] Add contributing doc --- CONTRIBUTING.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..fd52c758 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,63 @@ +# Contributing to WebSphere Liberty Container Images + +There are multiple ways to contribute: report bugs, fix bugs, contribute code, improve documentation, etc. You must follow the established process and guidelines. We welcome your contributions! + +- [Raising issues](#Raising-Issues) +- [Legal](#Legal) +- [Coding Standards](#Coding-Standards) + +## Raising Issues + +Please raise any bug reports on the [WebSphere Liberty Container Images project repository's GitHub issue tracker](https://github.com/WASdev/ci.docker/issues). Search the list to see if your issue has already been raised. + +A good bug report is one that makes it easy for everyone to understand what you were trying to do and what went wrong. Please provide as much context as possible so we can try to recreate the issue. + +## Legal + +We use the same approach - the Developer's Certificate of Origin 1.1 (DCO) - that the Linux® Kernel community uses to manage code contributions. + +For us to accept pull requests, you must declare that you wrote the code or, at least, have the right to contribute it to the repo under the open source license of the project in the repo. It's that easy. + +1. Read the following terms from [DCO](https://elinux.org/Developer_Certificate_Of_Origin) : + + ``` +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. + ``` + +2. If you can certify that it is true, sign off your `git commit` with a message like this: + ``` + Signed-off-by: John Doe + ``` + You must use your real name (no pseudonyms or anonymous contributions, sorry). + + Instead of typing that in every git commit message, your Git tools might let you automatically add the details for you. If you configure them to do that, when you issue the `git commit` command, just add the `-s` option. + +If you are an IBMer, please contact us directly, as the contribution process is slightly different. + +## Coding Standards + +Please ensure you follow the coding standards used throughout the existing code base. From 4d5b507c2f4be81157350f6976e1b678b5251800 Mon Sep 17 00:00:00 2001 From: Leo Christy Jesuraj Date: Sun, 13 Apr 2025 18:08:08 -0400 Subject: [PATCH 2/2] Update contributing doc --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fd52c758..83eb5315 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to WebSphere Liberty Container Images -There are multiple ways to contribute: report bugs, fix bugs, contribute code, improve documentation, etc. You must follow the established process and guidelines. We welcome your contributions! +There are multiple ways to contribute: report bugs, request features, fix bugs, contribute code, improve documentation, etc. You must follow the established process and guidelines. We welcome your contributions! - [Raising issues](#Raising-Issues) - [Legal](#Legal) @@ -8,7 +8,7 @@ There are multiple ways to contribute: report bugs, fix bugs, contribute code, i ## Raising Issues -Please raise any bug reports on the [WebSphere Liberty Container Images project repository's GitHub issue tracker](https://github.com/WASdev/ci.docker/issues). Search the list to see if your issue has already been raised. +Please raise any bug reports or feature requests on the [WebSphere Liberty Container Images project repository's GitHub issue tracker](https://github.com/WASdev/ci.docker/issues). Search the list to see if your issue has already been raised. A good bug report is one that makes it easy for everyone to understand what you were trying to do and what went wrong. Please provide as much context as possible so we can try to recreate the issue.