This is an automated email from the ASF dual-hosted git repository.
mbuenger pushed a commit to branch maven-filtering-3.x
in repository https://gitbox.apache.org/repos/asf/maven-filtering.git
The following commit(s) were added to refs/heads/maven-filtering-3.x by this
push:
new d629c48 Enable Github Issues (3.x) (#155)
d629c48 is described below
commit d629c489a876abeebe8d368a264fddfb79897997
Author: Matthias Bünger <buk...@users.noreply.github.com>
AuthorDate: Mon May 12 17:45:41 2025 +0200
Enable Github Issues (3.x) (#155)
---
.github/pull_request_template.md | 31 +++++++++++++------------------
README.md | 24 ++++--------------------
pom.xml | 4 ++--
3 files changed, 19 insertions(+), 40 deletions(-)
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 0e6b903..51e18bc 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,28 +1,23 @@
-Following this checklist to help us incorporate your
+Following this checklist to help us incorporate your
contribution quickly and easily:
- - [ ] Make sure there is a [JIRA
issue](https://issues.apache.org/jira/browse/MSHARED) filed
- for the change (usually before you start working on it). Trivial
changes like typos do not
- require a JIRA issue. Your pull request should address just this
issue, without
- pulling in other changes.
- - [ ] Each commit in the pull request should have a meaningful subject line
and body.
- - [ ] Format the pull request title like `[MSHARED-XXX] - Fixes bug in
ApproximateQuantiles`,
- where you replace `MSHARED-XXX` with the appropriate JIRA issue. Best
practice
- is to use the JIRA issue title in the pull request title and in the
first line of the
- commit message.
- - [ ] Write a pull request description that is detailed enough to understand
what the pull request does, how, and why.
- - [ ] Run `mvn clean verify -Prun-its` to make sure basic checks pass. A more
thorough check will
- be performed on your pull request automatically.
+- [ ] Your pull request should address just one issue, without pulling in
other changes.
+- [ ] Write a pull request description that is detailed enough to understand
what the pull request does, how, and why.
+- [ ] Each commit in the pull request should have a meaningful subject line
and body.
+ Note that commits might be squashed by a maintainer on merge.
+- [ ] Write unit tests that match behavioral changes, where the tests fail if
the changes to the runtime are not applied.
+ This may not always be possible but is a best-practice.
+- [ ] Run `mvn verify` to make sure basic checks pass.
+ A more thorough check will be performed on your pull request automatically.
+- [ ] You have run the integration tests successfully (`mvn -Prun-its verify`).
If your pull request is about ~20 lines of code you don't need to sign an
[Individual Contributor License
Agreement](https://www.apache.org/licenses/icla.pdf) if you are unsure
please ask on the developers list.
-To make clear that you license your contribution under
+To make clear that you license your contribution under
the [Apache License Version 2.0, January
2004](http://www.apache.org/licenses/LICENSE-2.0)
you have to acknowledge this by using the following check-box.
- - [ ] I hereby declare this contribution to be licensed under the [Apache
License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
-
- - [ ] In any other case, please file an [Apache Individual Contributor
License Agreement](https://www.apache.org/licenses/icla.pdf).
-
+- [ ] I hereby declare this contribution to be licenced under the [Apache
License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
+- [ ] In any other case, please file an [Apache Individual Contributor License
Agreement](https://www.apache.org/licenses/icla.pdf).
diff --git a/README.md b/README.md
index bded378..78e4651 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,6 @@
Contributing to [Apache Maven
Filtering](https://maven.apache.org/shared/maven-filtering/)
======================
-[][jira]
[][license]
[](https://search.maven.org/artifact/org.apache.maven.shared/maven-filtering)
[](https://github.com/jvm-repo-rebuild/reproducible-central/blob/master/content/org/apache/maven/shared/maven-filtering/README.md)
@@ -25,7 +24,7 @@ Contributing to [Apache Maven
Filtering](https://maven.apache.org/shared/maven-f
[][test-results]
-You have found a bug or you have an idea for a cool new feature? Contributing
+You have found a bug, or you have an idea for a cool new feature? Contributing
code is a great way to give something back to the open source community. Before
you dig right into the code, there are a few guidelines that we need
contributors to follow so that we can have a chance of keeping on top of
@@ -34,7 +33,6 @@ things.
Getting Started
---------------
-+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
+ Make sure you have a [GitHub account](https://github.com/signup/free).
+ If you're planning to implement a new feature, it makes sense to discuss
your changes
on the [dev list][ml-list] first.
@@ -60,37 +58,23 @@ There are some guidelines which will make applying PRs
easier for us:
+ Create minimal diffs - disable on save actions like reformat source code
or organize imports.
If you feel the source code should be reformatted, create a separate PR
for this change.
+ Check for unnecessary whitespace with `git diff --check` before committing.
-+ Make sure your commit messages are in the proper format. Your commit message
should contain the key of the JIRA issue.
-```
-[MSHARED-XXX] - Subject of the JIRA Ticket
- Optional supplemental description.
-```
+ Make sure you have added the necessary tests (JUnit/IT) for your changes.
+ Run all the tests with `mvn -Prun-its verify` to assure nothing else was
accidentally broken.
+ Submit a pull request to the repository in the Apache organization.
-+ Update your JIRA ticket and include a link to the pull request in the ticket.
If you plan to contribute on a regular basis, please consider filing a
[contributor license agreement][cla].
-Making Trivial Changes
-----------------------
-
-For changes of a trivial nature to comments and documentation, it is not always
-necessary to create a new ticket in JIRA. In this case, it is appropriate to
-start the first line of a commit with '(doc)' instead of a ticket number.
-
Additional Resources
--------------------
+ [Contributing
patches](https://maven.apache.org/guides/development/guide-maven-development.html#Creating_and_submitting_a_patch)
-+ [Apache Maven Shared Components project page][jira]
+ [Contributor License Agreement][cla]
+ [General GitHub documentation](https://help.github.com/)
+ [GitHub pull request
documentation](https://help.github.com/send-pull-requests/)
-+ [Apache Maven Twitter Account](https://twitter.com/ASFMavenProject)
-+ #Maven IRC channel on freenode.org
++ [Apache Maven X Account](https://x.com/ASFMavenProject)
++ [Apache Maven Bluesky Account](https://bsky.app/profile/maven.apache.org)
++ [Apache Maven Mastodon
Account](https://mastodon.social/deck/@asfmavenproj...@fosstodon.org)
-[jira]: https://issues.apache.org/jira/projects/MSHARED/
[license]: https://www.apache.org/licenses/LICENSE-2.0
[ml-list]: https://maven.apache.org/mailing-lists.html
[code-style]: https://maven.apache.org/developers/conventions/code.html
diff --git a/pom.xml b/pom.xml
index 220bc5d..3f62e67 100644
--- a/pom.xml
+++ b/pom.xml
@@ -46,8 +46,8 @@
<url>https://github.com/apache/maven-filtering/tree/${project.scm.tag}</url>
</scm>
<issueManagement>
- <system>JIRA</system>
-
<url>https://issues.apache.org/jira/issues/?jql=project%20%3D%20MSHARED%20AND%20component%20%3D%20maven-filtering</url>
+ <system>GitHub Issues</system>
+ <url>https://github.com/apache/maven-filtering/issues</url>
</issueManagement>
<ciManagement>
<system>Jenkins</system>
