Skip to content

Commit 5808d1a

Browse files
authored
Merge pull request #116 from infinum/housekeeping/incorporate-open-source-template
Incorporate open source template
2 parents e9e5821 + 865052e commit 5808d1a

10 files changed

Lines changed: 273 additions & 190 deletions

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 29 deletions
This file was deleted.
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Bug report
2+
description: Create a report to help us improve
3+
labels: bug
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: 📖 Description
9+
description: A clear and concise description of what the bug is.
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: environment
14+
attributes:
15+
label: ℹ️ Environment
16+
description: |
17+
An environment information where issue occurred. Try to provide as much information as possible, including:
18+
- device name, model and manufacturer (e.g. Google Pixel 10)
19+
- operating system version (e.g. Android 16)
20+
- software name, version and build number (e.g android_dbinspector 5.4.9)
21+
- additional information (e.g. dependencies, IDE, etc.)
22+
value: |
23+
- Device:
24+
- Operating system:
25+
- Software information:
26+
- Additional information:
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: reproduction-steps
31+
attributes:
32+
label: 💣 Steps to reproduce
33+
description: Steps to reproduce the behavior.
34+
value: |
35+
1. Go to '...'
36+
2. Click on '....'
37+
3. Scroll down to '....'
38+
...
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: expected-behavior
43+
attributes:
44+
label: 🔧 Expected behavior
45+
description: A clear and concise description of what you expected to happen.
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: additional-information
50+
attributes:
51+
label: 📄 Additional information
52+
description: Any additional information that might be helpful in solving the issue. Including screenshots, logs, etc.
53+
validations:
54+
required: false

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 22 deletions
This file was deleted.
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Feature request
2+
description: Propose a new feature or an idea for this project
3+
labels: enhancement
4+
body:
5+
- type: textarea
6+
id: feature-description
7+
attributes:
8+
label: 💡 Feature description
9+
description: A clear and concise description of the feature request, including what problem it solves.
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: additional-information
14+
attributes:
15+
label: ℹ️ Additional information
16+
description: An additional information or screenshots about the feature request.
17+
validations:
18+
required: false
19+
- type: textarea
20+
id: alternatives
21+
attributes:
22+
label: 🤔 Describe alternatives you've considered
23+
description: Can you think of alternative approaches to achieve same goal?
24+
validations:
25+
required: false

.github/PULL_REQUEST_TEMPLATE

Lines changed: 0 additions & 20 deletions
This file was deleted.

.github/pull_request_template.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## Summary
2+
3+
<!--
4+
Provide an overview of what this pull request aims to address or achieve.
5+
-->
6+
7+
**Related issue**: <!-- Add the issue number in format [#<number>](link) or set to "None" if this is not related to a reported issue. -->
8+
9+
## Changes
10+
11+
### Type
12+
13+
- [ ] **Feature**: This pull request introduces a new feature.
14+
- [ ] **Bug fix**: This pull request fixes a bug.
15+
- [ ] **Refactor**: This pull request refactors existing code.
16+
- [ ] **Documentation**: This pull request updates documentation.
17+
- [ ] **Other**: This pull request makes other changes.
18+
19+
#### Additional information
20+
21+
- [ ] This pull request introduces a **breaking change**.
22+
23+
### Description
24+
25+
<!--
26+
Describe the specific changes made in this pull request, including any technical details or architectural decisions.
27+
28+
If applicable, include additional information like screenshots, logs or other data that demonstrate the changes.
29+
-->
30+
31+
## Checklist
32+
33+
- [ ] I have performed a self-review of my own code.
34+
- [ ] I have tested my changes, including edge cases.
35+
- [ ] I have added necessary tests for the changes introduced (if applicable).
36+
- [ ] I have updated the documentation to reflect my changes (if applicable).
37+
38+
## Additional notes
39+
40+
<!--
41+
Add any additional comments, instructions, or insights about this pull request.
42+
-->

CODE_OF_CONDUCT.md

Lines changed: 50 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -1,128 +1,74 @@
1-
# Contributor Covenant Code of Conduct
1+
# Code of conduct
22

3-
## Our Pledge
3+
## Our pledge
44

5-
We as members, contributors, and leaders pledge to make participation in our
6-
community a harassment-free experience for everyone, regardless of age, body
7-
size, visible or invisible disability, ethnicity, sex characteristics, gender
8-
identity and expression, level of experience, education, socio-economic status,
9-
nationality, personal appearance, race, religion, or sexual identity
10-
and orientation.
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
1111

12-
We pledge to act and interact in ways that contribute to an open, welcoming,
13-
diverse, inclusive, and healthy community.
12+
## Our standards
1413

15-
## Our Standards
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
1616

17-
Examples of behavior that contributes to a positive environment for our
18-
community include:
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
1922

20-
* Demonstrating empathy and kindness toward other people
21-
* Being respectful of differing opinions, viewpoints, and experiences
22-
* Giving and gracefully accepting constructive feedback
23-
* Accepting responsibility and apologizing to those affected by our mistakes,
24-
and learning from the experience
25-
* Focusing on what is best not just for us as individuals, but for the
26-
overall community
23+
Examples of unacceptable behavior by participants include:
2724

28-
Examples of unacceptable behavior include:
29-
30-
* The use of sexualized language or imagery, and sexual attention or
31-
advances of any kind
32-
* Trolling, insulting or derogatory comments, and personal or political attacks
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
3328
* Public or private harassment
34-
* Publishing others' private information, such as a physical or email
35-
address, without their explicit permission
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
3631
* Other conduct which could reasonably be considered inappropriate in a
37-
professional setting
32+
professional setting
3833

39-
## Enforcement Responsibilities
34+
## Our responsibilities
4035

41-
Community leaders are responsible for clarifying and enforcing our standards of
42-
acceptable behavior and will take appropriate and fair corrective action in
43-
response to any behavior that they deem inappropriate, threatening, offensive,
44-
or harmful.
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
4539

46-
Community leaders have the right and responsibility to remove, edit, or reject
47-
comments, commits, code, wiki edits, issues, and other contributions that are
48-
not aligned to this Code of Conduct, and will communicate reasons for moderation
49-
decisions when appropriate.
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
5045

5146
## Scope
5247

53-
This Code of Conduct applies within all community spaces, and also applies when
54-
an individual is officially representing the community in public spaces.
55-
Examples of representing our community include using an official e-mail address,
56-
posting via an official social media account, or acting as an appointed
57-
representative at an online or offline event.
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
5854

5955
## Enforcement
6056

6157
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62-
reported to the community leaders responsible for enforcement at
63-
64-
All complaints will be reviewed and investigated promptly and fairly.
65-
66-
All community leaders are obligated to respect the privacy and security of the
67-
reporter of any incident.
68-
69-
## Enforcement Guidelines
70-
71-
Community leaders will follow these Community Impact Guidelines in determining
72-
the consequences for any action they deem in violation of this Code of Conduct:
73-
74-
### 1. Correction
75-
76-
**Community Impact**: Use of inappropriate language or other behavior deemed
77-
unprofessional or unwelcome in the community.
78-
79-
**Consequence**: A private, written warning from community leaders, providing
80-
clarity around the nature of the violation and an explanation of why the
81-
behavior was inappropriate. A public apology may be requested.
82-
83-
### 2. Warning
84-
85-
**Community Impact**: A violation through a single incident or series
86-
of actions.
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
8763

88-
**Consequence**: A warning with consequences for continued behavior. No
89-
interaction with the people involved, including unsolicited interaction with
90-
those enforcing the Code of Conduct, for a specified period of time. This
91-
includes avoiding interactions in community spaces as well as external channels
92-
like social media. Violating these terms may lead to a temporary or
93-
permanent ban.
94-
95-
### 3. Temporary Ban
96-
97-
**Community Impact**: A serious violation of community standards, including
98-
sustained inappropriate behavior.
99-
100-
**Consequence**: A temporary ban from any sort of interaction or public
101-
communication with the community for a specified period of time. No public or
102-
private interaction with the people involved, including unsolicited interaction
103-
with those enforcing the Code of Conduct, is allowed during this period.
104-
Violating these terms may lead to a permanent ban.
105-
106-
### 4. Permanent Ban
107-
108-
**Community Impact**: Demonstrating a pattern of violation of community
109-
standards, including sustained inappropriate behavior, harassment of an
110-
individual, or aggression toward or disparagement of classes of individuals.
111-
112-
**Consequence**: A permanent ban from any sort of public interaction within
113-
the community.
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
11467

11568
## Attribution
11669

117-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118-
version 2.0, available at
119-
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120-
121-
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122-
enforcement ladder](https://github.com/mozilla/diversity).
123-
124-
[homepage]: https://www.contributor-covenant.org
70+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
71+
available [here](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).
12572

126-
For answers to common questions about this code of conduct, see the FAQ at
127-
https://www.contributor-covenant.org/faq. Translations are available at
128-
https://www.contributor-covenant.org/translations.
73+
For answers to common questions about this code of conduct, visit
74+
the [FAQ](https://www.contributor-covenant.org/faq) page.

0 commit comments

Comments
 (0)