This is an automated email from the ASF dual-hosted git repository. sjaranowski pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/maven-project-info-reports-plugin.git
The following commit(s) were added to refs/heads/master by this push: new 3f47dd0 Enable GitHub Issues 3f47dd0 is described below commit 3f47dd0721e9b233743f523392e045b531c13b8c Author: Slawomir Jaranowski <s.jaranow...@gmail.com> AuthorDate: Sat Feb 22 09:12:17 2025 +0100 Enable GitHub Issues --- .asf.yaml | 6 ++- .asf.yaml => .github/ISSUE_TEMPLATE/BUG.yml | 59 +++++++++++++++---------- .asf.yaml => .github/ISSUE_TEMPLATE/FEATURE.yml | 46 +++++++++---------- .asf.yaml => .github/ISSUE_TEMPLATE/config.yml | 41 +++++++---------- .github/pull_request_template.md | 32 ++++++-------- README.md | 17 ------- pom.xml | 30 +------------ 7 files changed, 94 insertions(+), 137 deletions(-) diff --git a/.asf.yaml b/.asf.yaml index b94b94d..400e241 100644 --- a/.asf.yaml +++ b/.asf.yaml @@ -30,8 +30,12 @@ github: rebase: true autolink_jira: - MPIR + del_branch_on_merge: true + features: + issues: true + notifications: commits: commits@maven.apache.org issues: iss...@maven.apache.org pullrequests: iss...@maven.apache.org - jira_options: link label comment + jira_options: link label diff --git a/.asf.yaml b/.github/ISSUE_TEMPLATE/BUG.yml similarity index 53% copy from .asf.yaml copy to .github/ISSUE_TEMPLATE/BUG.yml index b94b94d..d49e4ce 100644 --- a/.asf.yaml +++ b/.github/ISSUE_TEMPLATE/BUG.yml @@ -1,37 +1,48 @@ -# +# # Licensed to the Apache Software Foundation (ASF) under one or more # contributor license agreements. See the NOTICE file distributed with # this work for additional information regarding copyright ownership. # The ASF licenses this file to You under the Apache License, Version 2.0 # (the "License"); you may not use this file except in compliance with # the License. You may obtain a copy of the License at -# +# # http://www.apache.org/licenses/LICENSE-2.0 -# +# # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # -# see https://s.apache.org/asfyaml -github: - description: "Apache Maven Project Info Reports Plugin" - homepage: https://maven.apache.org/plugins/maven-project-info-reports-plugin/ - labels: - - java - - build-management - - maven-plugins - - maven-project-info-reports-plugin - - maven - enabled_merge_buttons: - squash: true - merge: false - rebase: true - autolink_jira: - - MPIR -notifications: - commits: commits@maven.apache.org - issues: iss...@maven.apache.org - pullrequests: iss...@maven.apache.org - jira_options: link label comment + +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema + +name: Bug Report +description: File a bug report +labels: ["bug"] + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report. + + Simple fixes in single PRs do not require issues. + + **Do you use the latest project version?** + + - type: input + id: version + attributes: + label: Affected version + validations: + required: true + + - type: textarea + id: massage + attributes: + label: Bug description + validations: + required: true + + diff --git a/.asf.yaml b/.github/ISSUE_TEMPLATE/FEATURE.yml similarity index 58% copy from .asf.yaml copy to .github/ISSUE_TEMPLATE/FEATURE.yml index b94b94d..343183d 100644 --- a/.asf.yaml +++ b/.github/ISSUE_TEMPLATE/FEATURE.yml @@ -1,37 +1,35 @@ -# +# # Licensed to the Apache Software Foundation (ASF) under one or more # contributor license agreements. See the NOTICE file distributed with # this work for additional information regarding copyright ownership. # The ASF licenses this file to You under the Apache License, Version 2.0 # (the "License"); you may not use this file except in compliance with # the License. You may obtain a copy of the License at -# +# # http://www.apache.org/licenses/LICENSE-2.0 -# +# # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # -# see https://s.apache.org/asfyaml -github: - description: "Apache Maven Project Info Reports Plugin" - homepage: https://maven.apache.org/plugins/maven-project-info-reports-plugin/ - labels: - - java - - build-management - - maven-plugins - - maven-project-info-reports-plugin - - maven - enabled_merge_buttons: - squash: true - merge: false - rebase: true - autolink_jira: - - MPIR -notifications: - commits: commits@maven.apache.org - issues: iss...@maven.apache.org - pullrequests: iss...@maven.apache.org - jira_options: link label comment + +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema + +name: Feature request +description: File a proposal for new feature, improvement +labels: ["enhancement"] + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this new feature, improvement proposal. + + - type: textarea + id: massage + attributes: + label: New feature, improvement proposal + validations: + required: true diff --git a/.asf.yaml b/.github/ISSUE_TEMPLATE/config.yml similarity index 58% copy from .asf.yaml copy to .github/ISSUE_TEMPLATE/config.yml index b94b94d..4613dfa 100644 --- a/.asf.yaml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,37 +1,30 @@ -# +# # Licensed to the Apache Software Foundation (ASF) under one or more # contributor license agreements. See the NOTICE file distributed with # this work for additional information regarding copyright ownership. # The ASF licenses this file to You under the Apache License, Version 2.0 # (the "License"); you may not use this file except in compliance with # the License. You may obtain a copy of the License at -# +# # http://www.apache.org/licenses/LICENSE-2.0 -# +# # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # -# see https://s.apache.org/asfyaml -github: - description: "Apache Maven Project Info Reports Plugin" - homepage: https://maven.apache.org/plugins/maven-project-info-reports-plugin/ - labels: - - java - - build-management - - maven-plugins - - maven-project-info-reports-plugin - - maven - enabled_merge_buttons: - squash: true - merge: false - rebase: true - autolink_jira: - - MPIR -notifications: - commits: commits@maven.apache.org - issues: iss...@maven.apache.org - pullrequests: iss...@maven.apache.org - jira_options: link label comment + +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser + +blank_issues_enabled: false + +contact_links: + + - name: Project Mailing Lists + url: https://maven.apache.org/mailing-lists.html + about: Please ask a question or discuss here + + - name: Old JIRA Issues + url: https://issues.apache.org/jira/projects/MPIR + about: Please search old JIRA issues diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 7000df1..51e18bc 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,29 +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/MPIR) 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 `[MPIR-XXX] - Fixes bug in ApproximateQuantiles`, - where you replace `MPIR-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` 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 clean verify`). +- [ ] 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 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). - +- [ ] 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 a985f38..059ec83 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,6 @@ Contributing to [Apache Maven Project Info Reports Plugin](https://maven.apache.org/plugins/maven-project-info-reports-plugin/) ====================== -[][jira] [][license] [](https://search.maven.org/artifact/org.apache.maven.plugins/maven-project-info-reports-plugin) [](https://github.com/jvm-repo-rebuild/reproducible-central/blob/master/content/org/apache/maven/plugins/maven-project-info-reports-plugin/README.md) @@ -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,25 +58,12 @@ 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. -``` -[MPIR-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 -------------------- @@ -88,9 +73,7 @@ Additional Resources + [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 -[jira]: https://issues.apache.org/jira/projects/MPIR/ [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 cd81f6e..0c351f6 100644 --- a/pom.xml +++ b/pom.xml @@ -99,8 +99,8 @@ under the License. <url>https://github.com/apache/maven-project-info-reports-plugin/tree/${project.scm.tag}</url> </scm> <issueManagement> - <system>JIRA</system> - <url>https://issues.apache.org/jira/browse/MPIR</url> + <system>GitHub</system> + <url>https://github.com/apache/maven-project-info-reports-plugin/isuess</url> </issueManagement> <ciManagement> <system>Jenkins</system> @@ -453,32 +453,6 @@ under the License. </reporting> <profiles> - <profile> - <id>reporting</id> - <reporting> - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-changes-plugin</artifactId> - <configuration> - <!-- For JIRA report --> - <columnNames>Type,Key,Summary,Assignee</columnNames> - <maxEntries>200</maxEntries> - <onlyCurrentVersion>true</onlyCurrentVersion> - <resolutionIds>Fixed</resolutionIds> - <sortColumnNames>Type,Key</sortColumnNames> - </configuration> - <reportSets> - <reportSet> - <reports> - <report>jira-report</report> - </reports> - </reportSet> - </reportSets> - </plugin> - </plugins> - </reporting> - </profile> <profile> <id>run-its</id> <properties>