Skip to content

Commit ec4e94e

Browse files
BukamaBukama
authored
Enable Github Issues
1 parent 7f2819d commit ec4e94e

File tree

11 files changed

+245
-22
lines changed

11 files changed

+245
-22
lines changed

‎.asf.yaml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ github:
2929
rebase: true
3030
autolink_jira:
3131
- MSHARED
32+
del_branch_on_merge: true
33+
features:
34+
issues: true
3235
notifications:
3336
commits: commits@maven.apache.org
3437
issues: issues@maven.apache.org

‎.github/ISSUE_TEMPLATE/BUG.yml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
#
2+
# Licensed to the Apache Software Foundation (ASF) under one or more
3+
# contributor license agreements. See the NOTICE file distributed with
4+
# this work for additional information regarding copyright ownership.
5+
# The ASF licenses this file to You under the Apache License, Version 2.0
6+
# (the "License"); you may not use this file except in compliance with
7+
# the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing, software
12+
# distributed under the License is distributed on an "AS IS" BASIS,
13+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
# See the License for the specific language governing permissions and
15+
# limitations under the License.
16+
#
17+
18+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
19+
20+
name: Bug Report
21+
description: File a bug report
22+
labels: ["bug"]
23+
24+
body:
25+
- type: markdown
26+
attributes:
27+
value: |
28+
Thanks for taking the time to fill out this bug report.
29+
30+
Simple fixes in single PRs do not require issues.
31+
32+
**Do you use the latest project version?**
33+
34+
- type: input
35+
id: version
36+
attributes:
37+
label: Affected version
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: message
43+
attributes:
44+
label: Bug description
45+
validations:
46+
required: true
47+
48+

‎.github/ISSUE_TEMPLATE/FEATURE.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
#
2+
# Licensed to the Apache Software Foundation (ASF) under one or more
3+
# contributor license agreements. See the NOTICE file distributed with
4+
# this work for additional information regarding copyright ownership.
5+
# The ASF licenses this file to You under the Apache License, Version 2.0
6+
# (the "License"); you may not use this file except in compliance with
7+
# the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing, software
12+
# distributed under the License is distributed on an "AS IS" BASIS,
13+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
# See the License for the specific language governing permissions and
15+
# limitations under the License.
16+
#
17+
18+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
19+
20+
name: Feature request
21+
description: File a proposal for new feature, improvement
22+
labels: ["enhancement"]
23+
24+
body:
25+
- type: markdown
26+
attributes:
27+
value: |
28+
Thanks for taking the time to fill out this new feature, improvement proposal.
29+
30+
- type: textarea
31+
id: message
32+
attributes:
33+
label: New feature, improvement proposal
34+
validations:
35+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
#
2+
# Licensed to the Apache Software Foundation (ASF) under one or more
3+
# contributor license agreements. See the NOTICE file distributed with
4+
# this work for additional information regarding copyright ownership.
5+
# The ASF licenses this file to You under the Apache License, Version 2.0
6+
# (the "License"); you may not use this file except in compliance with
7+
# the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing, software
12+
# distributed under the License is distributed on an "AS IS" BASIS,
13+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
# See the License for the specific language governing permissions and
15+
# limitations under the License.
16+
#
17+
18+
# 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
19+
20+
blank_issues_enabled: false
21+
22+
contact_links:
23+
24+
- name: Project Mailing Lists
25+
url: https://maven.apache.org/mailing-lists.html
26+
about: Please ask a question or discuss here
27+
28+
- name: Old JIRA Issues
29+
url: https://issues.apache.org/jira/browse/?jql=project%20%3D%20MSHARED%20AND%20component%20%3D%20maven-shared-io
30+
about: Please search old JIRA issues

‎.github/pull_request_template.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Following this checklist to help us incorporate your
2+
contribution quickly and easily:
3+
4+
- [ ] Your pull request should address just one issue, without pulling in other changes.
5+
- [ ] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
6+
- [ ] Each commit in the pull request should have a meaningful subject line and body.
7+
Note that commits might be squashed by a maintainer on merge.
8+
- [ ] Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied.
9+
This may not always be possible but is a best-practice.
10+
- [ ] Run `mvn verify` to make sure basic checks pass.
11+
A more thorough check will be performed on your pull request automatically.
12+
- [ ] You have run the integration tests successfully (`mvn -Prun-its verify`).
13+
14+
If your pull request is about ~20 lines of code you don't need to sign an
15+
[Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf) if you are unsure
16+
please ask on the developers list.
17+
18+
To make clear that you license your contribution under
19+
the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
20+
you have to acknowledge this by using the following check-box.
21+
22+
- [ ] 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)
23+
- [ ] In any other case, please file an [Apache Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).

‎.github/release-drafter.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The ASF licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
18+
_extends: maven-gh-actions-shared

‎.github/workflows/pr-automation.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The ASF licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
18+
name: PR Automation
19+
on:
20+
pull_request_target:
21+
types:
22+
- closed
23+
24+
jobs:
25+
pr-automation:
26+
name: PR Automation
27+
uses: apache/maven-gh-actions-shared/.github/workflows/pr-automation.yml@v4

‎.github/workflows/release-drafter.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The ASF licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
18+
name: Release Drafter
19+
on:
20+
push:
21+
branches:
22+
- master
23+
workflow_dispatch:
24+
25+
jobs:
26+
update_release_draft:
27+
uses: apache/maven-gh-actions-shared/.github/workflows/release-drafter.yml@v4

‎.github/workflows/stale.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The ASF licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
18+
name: Stale
19+
20+
on:
21+
schedule:
22+
- cron: '33 16 * * *'
23+
issue_comment:
24+
types: [ 'created' ]
25+
26+
jobs:
27+
stale:
28+
uses: 'apache/maven-gh-actions-shared/.github/workflows/stale.yml@v4'

‎README.md‎

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,13 @@
1717
Contributing to [Apache Maven Shared IO](https://maven.apache.org/shared/maven-shared-io/)
1818
======================
1919

20-
[![ASF Jira](https://img.shields.io/endpoint?url=https%3A%2F%2Fmaven.apache.org%2Fbadges%2Fasf_jira-MSHARED.json)][jira]
2120
[![Apache License, Version 2.0, January 2004](https://img.shields.io/github/license/apache/maven.svg?label=License)][license]
2221
[![Maven Central](https://img.shields.io/maven-central/v/org.apache.maven.shared/maven-shared-io.svg?label=Maven%20Central)](https://search.maven.org/artifact/org.apache.maven.shared/maven-shared-io)
2322
[![Jenkins Status](https://img.shields.io/jenkins/s/https/ci-maven.apache.org/job/Maven/job/maven-box/job/maven-shared-io/job/master.svg)][build]
2423
[![Jenkins tests](https://img.shields.io/jenkins/t/https/ci-maven.apache.org/job/Maven/job/maven-box/job/maven-shared-io/job/master.svg)][test-results]
2524

2625

27-
You have found a bug or you have an idea for a cool new feature? Contributing
26+
You have found a bug, or you have an idea for a cool new feature? Contributing
2827
code is a great way to give something back to the open source community. Before
2928
you dig right into the code, there are a few guidelines that we need
3029
contributors to follow so that we can have a chance of keeping on top of
@@ -33,7 +32,6 @@ things.
3332
Getting Started
3433
---------------
3534

36-
+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
3735
+ Make sure you have a [GitHub account](https://github.com/signup/free).
3836
+ If you're planning to implement a new feature, it makes sense to discuss your changes
3937
on the [dev list][ml-list] first.
@@ -59,37 +57,23 @@ There are some guidelines which will make applying PRs easier for us:
5957
+ Create minimal diffs - disable on save actions like reformat source code or organize imports.
6058
If you feel the source code should be reformatted, create a separate PR for this change.
6159
+ Check for unnecessary whitespace with `git diff --check` before committing.
62-
+ Make sure your commit messages are in the proper format. Your commit message should contain the key of the JIRA issue.
63-
```
64-
[MSHARED-XXX] - Subject of the JIRA Ticket
65-
Optional supplemental description.
66-
```
6760
+ Make sure you have added the necessary tests (JUnit/IT) for your changes.
6861
+ Run all the tests with `mvn -Prun-its verify` to assure nothing else was accidentally broken.
6962
+ Submit a pull request to the repository in the Apache organization.
70-
+ Update your JIRA ticket and include a link to the pull request in the ticket.
7163

7264
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement][cla].
7365

74-
Making Trivial Changes
75-
----------------------
76-
77-
For changes of a trivial nature to comments and documentation, it is not always
78-
necessary to create a new ticket in JIRA. In this case, it is appropriate to
79-
start the first line of a commit with '(doc)' instead of a ticket number.
80-
8166
Additional Resources
8267
--------------------
8368

8469
+ [Contributing patches](https://maven.apache.org/guides/development/guide-maven-development.html#Creating_and_submitting_a_patch)
85-
+ [Apache Maven Shared Components project page][jira]
8670
+ [Contributor License Agreement][cla]
8771
+ [General GitHub documentation](https://help.github.com/)
8872
+ [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
89-
+ [Apache Maven Twitter Account](https://twitter.com/ASFMavenProject)
90-
+ #Maven IRC channel on freenode.org
73+
+ [Apache Maven X Account](https://x.com/ASFMavenProject)
74+
+ [Apache Maven Bluesky Account](https://bsky.app/profile/maven.apache.org)
75+
+ [Apache Maven Mastodon Account](https://mastodon.social/deck/@ASFMavenProject@fosstodon.org)
9176

92-
[jira]: https://issues.apache.org/jira/projects/MSHARED/
9377
[license]: https://www.apache.org/licenses/LICENSE-2.0
9478
[ml-list]: https://maven.apache.org/mailing-lists.html
9579
[code-style]: https://maven.apache.org/developers/conventions/code.html

0 commit comments

Comments
 (0)