8000 chore: github setup improvements · bazel-contrib/rules_python@6ce8e54 · GitHub
[go: up one dir, main page]
Skip to content

Commit 6ce8e54

Browse files
author
Alex Eagle
committed
chore: github setup improvements
See https://docs.github.com/en/github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests This will ask users filing an issue to indicate if it's a bug or a feature request and prompt them to include answers to common questions, reducing how many round-trips they need from maintainers. Same for pull requests, especially to think about whether this is a breaking change. Also add a .bazelversion file to pin the version devs and CI use when developing in the repo. In the future we might want rules_codeowners to generate the .github/CODEOWNERS file as we expand community maintainers
1 parent cd55272 commit 6ce8e54

File tree

5 files changed

+169
-0
lines changed

5 files changed

+169
-0
lines changed

‎.bazelversion

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.3.1

‎CODEOWNERS renamed to ‎.github/CODEOWNERS

File renamed without changes.

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
name: "\U0001F41EBug report"
3+
about: Report a bug in rules_python
4+
---
5+
<!--🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅
6+
7+
Oh hi there! 😄
8+
9+
To expedite issue processing please search open and closed issues before submitting a new one.
10+
Existing issues often contain information about workarounds, resolution, or progress updates.
11+
12+
🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅-->
13+
14+
15+
# 🐞 bug report
16+
17+
### Affected Rule
18+
19+
<!-- Can you pin-point one or more rules as the source of the bug? -->
20+
<!-- ✍️edit: --> The issue is caused by the rule:
21+
22+
23+
### Is this a regression?
24+
25+
<!-- Did this behavior use to work in the previous version? -->
26+
<!-- ✍️--> Yes, the previous version in which this bug was not present was: ....
27+
28+
29+
### Description
30+
31+
<!-- ✍️--> A clear and concise description of the problem...
32+
33+
34+
## 🔬 Minimal Reproduction
35+
36+
<!--
37+
Please create and share minimal reproduction of the issue. For the purpose you can create a GitHub repository and share a link. Make sure you don't upload any confidential files.
38+
-->
39+
40+
## 🔥 Exception or Error
41+
42+
<pre><code>
43+
<!-- If the issue is accompanied by an exception or an error, please share it below: -->
44+
<!-- ✍️-->
45+
46+
</code></pre>
47+
48+
49+
## 🌍 Your Environment
50+
51+
**Operating System:**
52+
53+
<pre>
54+
<code>
55+
56+
</code>
57+
</pre>
58+
59+
**Output of `bazel version`:**
60+
61+
<pre>
62+
<code>
63+
64+
</code>
65+
</pre>
66+
67+
**Rules_python version:**
68+
69+
<pre>
70+
<code>
71+
72+
</code>
73+
</pre>
74+
75+
**Anything else relevant?**
76+

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
name: "\U0001F680Feature request"
3+
about: Suggest a feature for rules_python
4+
5+
---
6+
<!--🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅
7+
8+
Oh hi there! 😄
9+
10+
To expedite issue processing please search open and closed issues before submitting a new one.
11+
Existing issues often contain information about workarounds, resolution, or progress updates.
12+
13+
🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅-->
14+
15+
16+
# 🚀 feature request
17+
18+
### Relevant Rules
19+
20+
<!-- Tell us if you want to add a feature to an existing rule or add a new rule -->
21+
22+
<!--
23+
24+
If you're looking for a new rule first make sure you check awesome-bazel for an
25+
curated list of existing bazel rules https://github.com/jin/awesome-bazel
26+
27+
If you don't find what you're looking for there, before opening a feature request make sure
28+
this repository is the right place for that.
29+
30+
We have a list of requirements that the rules in this repository need to follow.
31+
You can check them in the README.md file of the project.
32+
33+
-->
34+
35+
### Description
36+
37+
<!-- ✍️--> A clear and concise description of the problem or missing capability...
38+
39+
40+
### Describe the solution you'd like
41+
42+
<!-- ✍️--> If you have a solution in mind, please describe it.
43+
44+
45+
### Describe alternatives you've considered
46+
47+
<!-- ✍️--> Have you considered any alternative solutions or workarounds?
48+

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## PR Checklist
2+
3+
Please check if your PR fulfills the following requirements:
4+
5+
- [ ] Tests for the changes have been added (for bug fixes / features)
6+
- [ ] Docs have been added / updated (for bug fixes / features)
7+
8+
9+
## PR Type
10+
11+
What kind of change does this PR introduce?
12+
13+
<!-- Please check the one that applies to this PR using "x". -->
14+
15+
- [ ] Bugfix
16+
- [ ] Feature (please, look at the "Scope of the project" section in the README.md file)
17+
- [ ] Code style update (formatting, local variables)
18+
- [ ] Refactoring (no functional changes, no api changes)
19+
- [ ] Build related changes
20+
- [ ] CI related changes
21+
- [ ] Documentation content changes
22+
- [ ] Other... Please describe:
23+
24+
25+
## What is the current behavior?
26+
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
27+
28+
Issue Number: N/A
29+
30+
31+
## What is the new behavior?
32+
33+
34+
## Does this PR introduce a breaking change?
35+
36+
- [ ] Yes
37+
- [ ] No
38+
39+
40+
<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
41+
42+
43+
## Other information
44+

0 commit comments

Comments
 (0)
0