From ca93874a7f05d1cb980b2690340dfaa2a9600a47 Mon Sep 17 00:00:00 2001 From: Tiago Bueno <49003339+tlbueno@users.noreply.github.com> Date: Tue, 14 Nov 2023 15:27:39 -0300 Subject: [PATCH] [#40] Add pull request template Add a pull requets template Signed-off-by: Tiago Bueno <49003339+tlbueno@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.md | 12 ++++--- .github/pull_request_template.md | 19 ++++++++++ CONTRIBUTING.md | 53 ++++++++++++++++++++++++++++ README.adoc | 3 +- 4 files changed, 81 insertions(+), 6 deletions(-) create mode 100644 .github/pull_request_template.md create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index e832bda..deef04f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -3,7 +3,7 @@ name: Bug report about: Create a report to help us improve title: '' labels: bug -assignees: RoddieKieley +assignees: '' --- @@ -12,14 +12,16 @@ A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: + 1. Get X version of the source 2. '...' **Platform (please complete the following information):** - - OS: [e.g. Fedora] - - Version [e.g. 32] - - CEKit version [e.g. 3.5.0] - - Container build tool [e.g. podman] + +- OS: [e.g. Fedora] +- Version [e.g. 32] +- CEKit version [e.g. 3.5.0] +- Container build tool [e.g. podman] **Expected behavior** Optional, use if not obvious. A clear and concise description of what you expected to happen. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..feade5a --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,19 @@ +# Pull Request + +Thanks for submitting your Pull Request! + +**Description:** +A clear and concise description of the changes + +**Related issue:** +The link to the issue + +Please make sure your PR meets the following requirements: + +- [ ] Pull Request title is properly formatted: `[#ISSUE-NUMBER] Subject` +- [ ] Pull Request contains link to the issue: `#31` or `Closes #31` +- [ ] Pull Request contains description of the issue +- [ ] Pull Request does not include fixes for issues other than the main ticket +- [ ] Attached commits represent units of work and are properly formatted +- [ ] You have read and agreed to the Developer Certificate of Origin (DCO) (see `CONTRIBUTING.md`) +- [ ] Every commit contains `Signed-off-by: Your Name ` - use `git commit -s` diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d933ee1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,53 @@ +# CONTRIBUTING + +This project requires the Developer Certificate of Origin (DCO) process to be +followed. The DCO is an attestation attached to every contribution made by every +developer, signifying that the developer licenses their contribution under the +open source license governing the file(s) being modified. In the commit message +of the contribution, simply add a Signed-off-by statement, which signifies +agreement to the text at , reproduced below: + +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. +1 Letterman Drive +Suite D4700 +San Francisco, CA, 94129 + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +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. + +The DCO requires a signoff message in the following format to appear on each +commit: + +`Signed-off-by: Your Name ` + +If you set your user.name and user.email git configs, you can sign your commit +automatically with git commit -s. diff --git a/README.adoc b/README.adoc index 9fdf9fc..4ddfc0a 100644 --- a/README.adoc +++ b/README.adoc @@ -31,9 +31,10 @@ The image special tags are: - `latest` - points to the image built from the sources of the latest release tag. -- - `dev.DATE.COMMIT_ID` - points to the image built from the sources of the main branch on specific date and commit id, it should be used only for development purposes. ie: `dev.20231106.8dbe9eb`. It expires in 3 months +- `dev.DATE.COMMIT_ID` - points to the image built from the sources of the main branch on specific date and commit id, it should be used only for development purposes. ie: `dev.20231106.8dbe9eb`. It expires in 3 months - `dev.latest` - points to the image built from the latest sources of the main branch, it should be used only for development purposes and it is regenerated on each commit on main branch. - `snapshot` - points to the image built from the latest sources of the main branch and contains the snapshot version of ActiveMQ Artemis +NOTE: Some tags are tied together at some point. We may have the `latest` tag been equal the tag for version `1.0.23` and also equal the tag for `artemis.2.31.2`. The same applies to `dev.latest` tag which will the equal the latest commit tag, ie: `dev.20231110.5cea3ed`