Skip to content

Commit a4d3ed1

Browse files
committed
Open source template
1 parent 0a7ac5c commit a4d3ed1

27 files changed

+728
-414
lines changed

.github/CODEOWNERS

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# This is a comment.
2+
# Each line is a file pattern followed by one or more owners.
3+
# Code owners are automatically requested for review when someone opens a pull request that modifies code that they own.
4+
# These owners will be the default owners for everything in the repo.
5+
* @Truba @doms99 @lukaknezic
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Bug report
2+
description: File a bug report.
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
19+
- operating system version
20+
- software name, version and build number
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: Reproduction steps
33+
description: Steps to reproduce the behavior.
34+
value: |
35+
1.
36+
2.
37+
3.
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.
53+
validations:
54+
required: false

.github/ISSUE_TEMPLATE/feature_request.yml

Whitespace-only changes.

.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: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Code of conduct
2+
3+
## Our pledge
4+
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.
11+
12+
## Our standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
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
22+
23+
Examples of unacceptable behavior by participants include:
24+
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
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our responsibilities
35+
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.
39+
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.
45+
46+
## Scope
47+
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.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
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.
63+
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.
67+
68+
## Attribution
69+
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).
72+
73+
For answers to common questions about this code of conduct, visit
74+
the [FAQ](https://www.contributor-covenant.org/faq) page.

CONTRIBUTING.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Contributing guidelines
2+
3+
Welcome to our project! We appreciate your interest in helping us improve it.
4+
5+
## How can I contribute?
6+
7+
There are multiple ways in which you can help us make this project even better.
8+
9+
- Reporting bugs or suggesting new features
10+
- Contributing code improvements or new features
11+
- Writing, updating, or fixing tests
12+
- Improving documentation, including inline comments, user manuals, and developer guides
13+
14+
## Issue reporting
15+
16+
If you found a bug or have an idea for a new feature, please open an issue. Be sure to include a clear and descriptive title, as well as a detailed description of the bug or feature.
17+
18+
To avoid duplicate issues, please check if a similar issue has already been created.
19+
20+
## Making changes
21+
22+
To make changes to the project, please follow these steps:
23+
24+
1. Fork the project repository.
25+
2. Create a new branch for your changes, based on the project's main branch.
26+
3. Make your changes. Ensure you've followed the coding style and standards.
27+
4. Test your changes thoroughly, ensuring all existing tests pass and new tests cover your changes where appropriate.
28+
5. Commit your changes with a clear and descriptive commit message.
29+
6. Push your changes to your fork.
30+
7. Create a pull request to the project's main branch.
31+
32+
Once we check everything, we will merge the changes into the main branch and include it in the next release.
33+
34+
## Guidelines for pull requests
35+
36+
When submitting a pull request, please ensure that:
37+
38+
- Your pull request is concise and well-scoped
39+
- Your code is properly tested
40+
- Your code adheres to the project's coding standards and style guidelines
41+
- Your commit message is clear and descriptive
42+
- Your pull request includes a description of the changes you have made and why you have made them
43+
44+
Try to avoid creating large pull requests that include multiple unrelated changes. Instead, break them down into smaller, more focused pull requests. This will make it easier for us to review and merge your changes.
45+
46+
## Code of conduct
47+
48+
We want to ensure a welcoming environment for everyone. With that in mind, all contributors are expected to follow our [code of conduct](/CODE_OF_CONDUCT.md).
49+
50+
## License
51+
52+
By submitting a pull request you agree to release that code under the project's [license](/LICENSE).

0 commit comments

Comments
 (0)