Skip to content

Commit a586207

Browse files
authoredApr 11, 2022
Add GitHub meta docs. (#776)
Adds: * issue templates * pull request template * CODE_OF_CONDUCT.md
1 parent 5f481a0 commit a586207

File tree

4 files changed

+214
-0
lines changed

4 files changed

+214
-0
lines changed
 

Diff for: ‎.github/ISSUE_TEMPLATE/bug_report.yml

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: Bug Report
2+
description: File a bug report
3+
title: "[Bug]: "
4+
labels: ["bug", "triage me"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
- type: checkboxes
11+
attributes:
12+
label: Is there an existing issue for this?
13+
description: Please search to see if an issue already exists for the bug you encountered.
14+
options:
15+
- label: I have searched the existing issues
16+
required: true
17+
- type: checkboxes
18+
attributes:
19+
label: Is there a StackOverflow question about this issue?
20+
description: Please search [StackOverflow](https://stackoverflow.com/questions/tagged/android-jetpack) if an issue with an answer already exists for the bug you encountered.
21+
options:
22+
- label: I have searched StackOverflow
23+
required: true
24+
- type: checkboxes
25+
attributes:
26+
label: Is this an issue related to one of the samples?
27+
description: Please confirm that this is an issue related to this sample repo. If this is a bug related to Compose, file an issue on the Compose [issue tracker](https://issuetracker.google.com/issues/new?component=612128) instead.
28+
options:
29+
- label: Yes, this is a specific issue related to this samples repo.
30+
required: true
31+
- type: dropdown
32+
id: sample-app
33+
attributes:
34+
label: Sample app
35+
description: What sample app did you encounter a bug on?
36+
options:
37+
- Crane
38+
- JetNews
39+
- Jetcaster
40+
- Jetchat
41+
- Jetsnack
42+
- Jetsurvey
43+
- Owl
44+
- Rally
45+
- Other (bug not related to sample app)
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: what-happened
50+
attributes:
51+
label: What happened?
52+
description: Also tell us, what did you expect to happen?
53+
placeholder: Tell us what you see!
54+
value: "A bug happened!"
55+
validations:
56+
required: true
57+
- type: textarea
58+
id: logs
59+
attributes:
60+
label: Relevant logcat output
61+
description: Please copy and paste any relevant logcat output. This will be automatically formatted into code, so no need for backticks.
62+
render: shell
63+
- type: checkboxes
64+
id: terms
65+
attributes:
66+
label: Code of Conduct
67+
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
68+
options:
69+
- label: I agree to follow this project's Code of Conduct
70+
required: true

Diff for: ‎.github/ISSUE_TEMPLATE/feature_request.yml

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: Feature request
2+
description: File a feature request
3+
title: "[FR]: "
4+
labels: ["enhancement", "triage me"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
- type: checkboxes
11+
attributes:
12+
label: Is there an existing issue for this?
13+
description: Please search to see if an issue already exists for this feature request.
14+
options:
15+
- label: I have searched the existing issues
16+
required: true
17+
- type: checkboxes
18+
attributes:
19+
label: Is this a feature request for one of the samples?
20+
description: Please confirm that this is a feature request related to this samples repo. If this is a request related to Compose, file a feature request on the Compose [issue tracker](https://issuetracker.google.com/issues/new?component=612128) instead.
21+
options:
22+
- label: Yes, this is a specific request related to this samples repo.
23+
required: true
24+
- type: dropdown
25+
id: sample-app
26+
attributes:
27+
label: Sample app
28+
description: Which sample app does this request apply to?
29+
options:
30+
- Crane
31+
- JetNews
32+
- Jetcaster
33+
- Jetchat
34+
- Jetsnack
35+
- Jetsurvey
36+
- Owl
37+
- Rally
38+
- Other (bug not related to sample app)
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: describe-problem
43+
attributes:
44+
label: Describe the problem
45+
description: Is your feature request related to a problem? Please describe.
46+
placeholder: I'm always frustrated when...
47+
validations:
48+
required: true
49+
- type: textarea
50+
id: solution
51+
attributes:
52+
label: Describe the solution
53+
description: Please describe the solution you'd like. A clear and concise description of what you want to happen.
54+
validations:
55+
required: true
56+
- type: textarea
57+
id: context
58+
attributes:
59+
label: Additional context
60+
description: Add any other context or screenshots about the feature request here.
61+
validations:
62+
required: false
63+
- type: checkboxes
64+
id: terms
65+
attributes:
66+
label: Code of Conduct
67+
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
68+
options:
69+
- label: I agree to follow this project's Code of Conduct
70+
required: true
+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: Pull request
3+
about: Create a pull request
4+
label: 'triage me'
5+
---
6+
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
7+
- [ ] Make sure to open a GitHub issue as a bug/feature request before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
8+
- [ ] Ensure the tests and linter pass
9+
- [ ] Appropriate docs were updated (if necessary)
10+
11+
Fixes #<issue_number_goes_here> 🦕

Diff for: ‎CODE_OF_CONDUCT.md

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Google Open Source Community Guidelines
2+
3+
At Google, we recognize and celebrate the creativity and collaboration of open
4+
source contributors and the diversity of skills, experiences, cultures, and
5+
opinions they bring to the projects and communities they participate in.
6+
7+
Every one of Google's open source projects and communities are inclusive
8+
environments, based on treating all individuals respectfully, regardless of
9+
gender identity and expression, sexual orientation, disabilities,
10+
neurodiversity, physical appearance, body size, ethnicity, nationality, race,
11+
age, religion, or similar personal characteristic.
12+
13+
We value diverse opinions, but we value respectful behavior more.
14+
15+
Respectful behavior includes:
16+
17+
* Being considerate, kind, constructive, and helpful.
18+
* Not engaging in demeaning, discriminatory, harassing, hateful, sexualized, or
19+
physically threatening behavior, speech, and imagery.
20+
* Not engaging in unwanted physical contact.
21+
22+
Some Google open source projects [may adopt][] an explicit project code of
23+
conduct, which may have additional detailed expectations for participants. Most
24+
of those projects will use our [modified Contributor Covenant][].
25+
26+
[may adopt]: https://opensource.google/docs/releasing/preparing/#conduct
27+
[modified Contributor Covenant]: https://opensource.google/docs/releasing/template/CODE_OF_CONDUCT/
28+
29+
## Resolve peacefully
30+
31+
We do not believe that all conflict is necessarily bad; healthy debate and
32+
disagreement often yields positive results. However, it is never okay to be
33+
disrespectful.
34+
35+
If you see someone behaving disrespectfully, you are encouraged to address the
36+
behavior directly with those involved. Many issues can be resolved quickly and
37+
easily, and this gives people more control over the outcome of their dispute.
38+
If you are unable to resolve the matter for any reason, or if the behavior is
39+
threatening or harassing, report it. We are dedicated to providing an
40+
environment where participants feel welcome and safe.
41+
42+
## Reporting problems
43+
44+
Some Google open source projects may adopt a project-specific code of conduct.
45+
In those cases, a Google employee will be identified as the Project Steward,
46+
who will receive and handle reports of code of conduct violations. In the event
47+
that a project hasn’t identified a Project Steward, you can report problems by
48+
emailing opensource@google.com.
49+
50+
We will investigate every complaint, but you may not receive a direct response.
51+
We will use our discretion in determining when and how to follow up on reported
52+
incidents, which may range from not taking action to permanent expulsion from
53+
the project and project-sponsored spaces. We will notify the accused of the
54+
report and provide them an opportunity to discuss it before any action is
55+
taken. The identity of the reporter will be omitted from the details of the
56+
report supplied to the accused. In potentially harmful situations, such as
57+
ongoing harassment or threats to anyone's safety, we may take action without
58+
notice.
59+
60+
*This document was adapted from the [IndieWeb Code of Conduct][] and can also
61+
be found at <https://opensource.google/conduct/>.*
62+
63+
[IndieWeb Code of Conduct]: https://indieweb.org/code-of-conduct

0 commit comments

Comments
 (0)
Please sign in to comment.