Skip to content

Commit 64f6b3d

Browse files
thurkathurka
committed
github setup
1 parent 379daff commit 64f6b3d

15 files changed

+1112
-1
lines changed

‎.github/CONTRIBUTING.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
21+
22+
# Contributing to Apache NetBeans
23+
24+
If you are a first time contributor, please read the [Contribution Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=74681408).

‎.github/ISSUE_TEMPLATE/01-netbeans_bug_report.yml‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
---
2+
name: Apache NetBeans VSCode bug report
3+
description: Problems and issues with Apache NetBeans VSCode
4+
labels: ["kind:bug", "needs:triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
# yamllint disable rule:line-length
9+
value: "
10+
<img src='https://raw.githubusercontent.com/apache/netbeans/master/nb/ide.branding/release/netbeans.png' align='left' width='64' height='64'>
11+
Thank you for finding the time to report the problem!
12+
13+
We really appreciate community efforts to improve Apache NetBeans VSCode.
14+
15+
Note, that you do not need to create an issue if you have a change ready to submit!
16+
17+
You can open a [Pull Request](https://github.com/apache/netbeans-vscode/pulls) immediately instead.
18+
<br clear='left'/>"
19+
# yamllint enable rule:line-length
20+
- type: dropdown
21+
attributes:
22+
label: Apache NetBeans VSCode version
23+
description: >
24+
Which Apache NetBeans VSCode version are you using? Only the latest release, latest
25+
release candidate (if available), and latest daily build are supported for bugs.
26+
If using an older version, please verify the bug is still valid before reporting.
27+
multiple: false
28+
options:
29+
- "Apache NetBeans VSCode 26"
30+
- "Apache NetBeans VSCode 27 latest release candidate"
31+
- "Apache NetBeans VSCode 28 latest daily build"
32+
validations:
33+
required: true
34+
- type: textarea
35+
attributes:
36+
label: What happened
37+
description: Describe what happened, what you expected to happen, and what went wrong.
38+
placeholder: >
39+
Please provide the context in which the problem occurred and explain what happened.
40+
Explain why you think the behaviour is erroneous. It is extremely helpful if you attach the messages.log file or copy&paste
41+
the fragment of logs showing the exact error messages or wrong behaviour and screenshots for
42+
UI problems or YouTube link to a video of you demonstrating the problem. You can include files by
43+
dragging and dropping them here.
44+
validations:
45+
required: true
46+
- type: input
47+
attributes:
48+
label: Language / Project Type / NetBeans Component
49+
description: >
50+
Narrow down the specific area, examples: 'Java Maven Web application project'.
51+
placeholder: "Java Maven Project using Java Modules (JPMS)"
52+
- type: textarea
53+
attributes:
54+
label: How to reproduce
55+
description: >
56+
What should we do to reproduce the problem? If you are not able to provide a reproducible case,
57+
please open a [Discussion](https://github.com/apache/netbeans-vscode/discussions) instead.
58+
placeholder: >
59+
Please make sure you provide a reproducible step-by-step case of how to reproduce the problem
60+
as minimally and precisely as possible. Remember that non-reproducible issues may be closed or
61+
converted into discussions. If we cannot reproduce an issue we cannot fix it!
62+
validations:
63+
required: true
64+
- type: dropdown
65+
attributes:
66+
label: Did this work correctly in an earlier version?
67+
description: >
68+
It's important to know whether bugs have been introduced by recent changes. If this used
69+
to work, select the last version that worked correctly from the list. Older versions can be
70+
specified in the description.
71+
multiple: false
72+
options:
73+
- "No / Don't know"
74+
- "Apache NetBeans VSCode 27"
75+
- "Apache NetBeans VSCode 26"
76+
- "Apache NetBeans VSCode 25"
77+
- "Apache NetBeans VSCode 24"
78+
- "Apache NetBeans VSCode 23 or earlier"
79+
validations:
80+
required: true
81+
- type: input
82+
attributes:
83+
label: Operating System
84+
description: What Operating System are you using?
85+
placeholder: "Please be as specific as you can - version, distribution, architecture, etc."
86+
validations:
87+
required: true
88+
- type: input
89+
attributes:
90+
label: JDK
91+
description: Which JDK are you using?
92+
placeholder: "Please be as specific as you can - version, distribution, architecture, etc."
93+
validations:
94+
required: true
95+
- type: textarea
96+
attributes:
97+
label: Anything else
98+
description: Anything else we need to know?
99+
placeholder: >
100+
How often does this problem occur? (Once? Every time? Only when certain conditions are met?)
101+
Any relevant logs to include? Put them here inside fenced
102+
``` ``` blocks or inside a foldable details tag if it's long:
103+
<details><summary>x.log</summary> lots of stuff </details>
104+
105+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
106+
- type: dropdown
107+
attributes:
108+
label: Are you willing to submit a pull request?
109+
description: >
110+
This is absolutely not required, but we are happy to guide you in the contribution process,
111+
especially if you already have a good understanding of how to implement the fix. <br>
112+
Apache NetBeans VSCode is a community-managed project and we love to bring new contributors in.
113+
options:
114+
- "No"
115+
- "Yes"
116+
validations:
117+
required: true
118+
# - type: dropdown
119+
# attributes:
120+
# label: Code of Conduct
121+
# description: >
122+
# The Code of Conduct helps create a safe space for everyone.
123+
# I agree to follow the Apache Software Foundation's
124+
# [Code of Conduct](https://www.apache.org/foundation/policies/conduct.html)
125+
# options:
126+
# - "Yes"
127+
# validations:
128+
# required: true
129+
# - type: markdown
130+
# attributes:
131+
# value: "Thank you for completing our form!"
132+
- type: markdown
133+
attributes:
134+
value: "**By submitting this form you agree to follow the Apache Software Foundation's
135+
[Code of Conduct](https://www.apache.org/foundation/policies/conduct.html)**.
136+
137+
The Code of Conduct helps create a safe space for everyone.
138+
139+
140+
Thank you for completing our form!"

‎.github/ISSUE_TEMPLATE/02-netbeans_feature_request.yml‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
name: Apache NetBeans VSCode feature request
3+
description: Suggest an idea to improve Apache NetBeans VSCode
4+
labels: ["kind:feature", "needs:triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
# yamllint disable rule:line-length
9+
value: "
10+
<img src='https://raw.githubusercontent.com/apache/netbeans/master/nb/ide.branding/release/netbeans.png' align='left' width='64' height='64'>
11+
Thank you for finding the time to propose a new feature!
12+
13+
We really appreciate community efforts to improve Apache NetBeans.
14+
15+
Note, that you do not need to create an issue if you have a change ready to submit!
16+
17+
You can open a [Pull Request](https://github.com/apache/netbeans-vscode/pulls) immediately instead.
18+
<br clear='left'/>"
19+
# yamllint enable rule:line-length
20+
- type: textarea
21+
attributes:
22+
label: Description
23+
description: A short description of your feature
24+
validations:
25+
required: true
26+
- type: textarea
27+
attributes:
28+
label: Use case/motivation
29+
description: What do you want to happen?
30+
placeholder: >
31+
Rather than telling us how you might implement this feature, try to take a
32+
step back and describe what you are trying to achieve.
33+
- type: textarea
34+
attributes:
35+
label: Related issues
36+
description: Is there currently another issue associated with this?
37+
- type: dropdown
38+
attributes:
39+
label: Are you willing to submit a pull request?
40+
description: >
41+
This is absolutely not required, but we are happy to guide you in the contribution process,
42+
especially if you already have a good understanding of how to implement the fix. <br>
43+
Apache NetBeans is a community-managed project and we love to bring new contributors in.
44+
options:
45+
- "No"
46+
- "Yes"
47+
validations:
48+
required: true
49+
# - type: dropdown
50+
# attributes:
51+
# label: Code of Conduct
52+
# description: >
53+
# The Code of Conduct helps create a safe space for everyone.
54+
# I agree to follow the Apache Software Foundation's
55+
# [Code of Conduct](https://www.apache.org/foundation/policies/conduct.html)
56+
# options:
57+
# - "Yes"
58+
# validations:
59+
# required: true
60+
# - type: markdown
61+
# attributes:
62+
# value: "Thank you for completing our form!"
63+
- type: markdown
64+
attributes:
65+
value: "**By submitting this form you agree to follow the Apache Software Foundation's
66+
[Code of Conduct](https://www.apache.org/foundation/policies/conduct.html)**.
67+
68+
The Code of Conduct helps create a safe space for everyone.
69+
70+
71+
Thank you for completing our form!"

‎.github/ISSUE_TEMPLATE/99-free_form.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Task and Meta
3+
description: (Maintainers only) Tasks and Meta issues for the project
4+
labels: ["kind:meta"]
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Body
9+
description: Free form issue for committers to be able to add tasks/meta issues
10+
- type: checkboxes
11+
attributes:
12+
label: Committer
13+
description: Committer acknowledgment.
14+
options:
15+
- label: I acknowledge that I am a maintainer/committer in the Apache NetBeans VSCode project.
16+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
blank_issues_enabled: false
3+
contact_links:
4+
- name: Ask a question (GitHub Discussions)
5+
url: https://github.com/apache/netbeans-vscode/discussions/
6+
about: Ask a question or request support for using Apache NetBeans VSCode.
7+
- name: Mailing lists
8+
url: https://netbeans.apache.org/community/mailing-lists
9+
about: Subscribe to the users, dev or announce mailing lists for Apache NetBeans.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
2+
3+
4+
5+
---
6+
**^Add meaningful description above**
7+
8+
<details open>
9+
<summary>Click to collapse/expand PR instructions</summary>
10+
11+
By opening a pull request you confirm that, unless explicitly stated otherwise, the changes -
12+
13+
- are all your own work, and you have the right to contribute them.
14+
- are contributed solely under the terms and conditions of the Apache License 2.0 (see section 5 of the license for more information).
15+
16+
Please make sure (eg. `git log`) that all commits have a valid name and email address for you in the Author field.
17+
18+
If you're a first time contributor, see the Contributing guidelines for more information.
19+
20+
If you're a committer, please label the PR before pressing "Create pull request" so that the right test jobs can run.
21+
22+
### PR approval and merge checklist:
23+
24+
1. [ ] Is this PR [squashed](https://cwiki.apache.org/confluence/display/NETBEANS/git%3A+squash+and+merge)?
25+
2. [ ] Are author name / email address correct? Are [co-authors](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors#creating-co-authored-commits-on-the-command-line) correctly listed? Do the commit messages need updates?
26+
3. [ ] Does the PR title and description still fit after the Nth iteration? Is the description sufficient to appear in the release notes?
27+
28+
</details>

‎.github/SECURITY.rst‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
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+
Reporting Vulnerabilities
19+
-------------------------
20+
21+
**⚠️ Please do not file GitHub issues for security vulnerabilities as they are public! ⚠️**
22+
23+
The Apache Software Foundation takes security issues very seriously. If you have any
24+
concern around Apache NetBeans security or believe you have uncovered a vulnerability,
25+
we suggest that you get in touch via the e-mail address security@apache.org. In the
26+
message, try to provide a description of the issue and ideally a way of reproducing it.
27+
The security team will get back to you after assessing the description. Please do not
28+
discuss the vulnerability publicly until we've had time to assess and address.
29+
30+
Note that this security address should be used only for undisclosed vulnerabilities.
31+
Dealing with fixed issues or general questions on use should be handled via the
32+
user and dev mailing lists.
33+
34+
The `ASF Security team's page <https://www.apache.org/security/>`_ describes how
35+
vulnerability reports are handled, and includes PGP keys if you wish to use that.

‎.github/dependabot.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
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+
version: 2
19+
updates:
20+
21+
- package-ecosystem: "github-actions"
22+
directory: "/"
23+
schedule:
24+
interval: "weekly"
25+
labels:
26+
- "Upgrade Library"
27+
- "CI"
28+
29+
# for project dependencies see .github/workflows/dependency-checks.yml

0 commit comments

Comments
 (0)