-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit ef10bdd
Showing
13 changed files
with
848 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
--- | ||
name: "\U0001F6A8 Bug" | ||
about: Did you come across a bug or unexpected behaviour differing from the docs? | ||
labels: bug | ||
--- | ||
|
||
<!-- | ||
Thanks for reporting a bug! | ||
Before opening a new issue, please make sure that we do not have any duplicates already open. | ||
You can ensure this by searching the issue list for this repository. | ||
If there is a duplicate, please close your issue and add a comment to the existing issue instead. | ||
--> | ||
|
||
## Describe the bug | ||
|
||
<!-- Describe your issue, but please be descriptive! Thanks again --> | ||
|
||
## Expected behaviour | ||
|
||
<!-- A clear and concise description of what you expected to happen. --> | ||
|
||
## Steps to reproduce the issue | ||
|
||
<!-- include screenshots, logs, code or other info to help explain your problem --> | ||
|
||
<!-- | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
--> | ||
|
||
## Technical details | ||
|
||
- Host Machine OS (Windows/Linux/Mac): | ||
|
||
## Possible Fix | ||
|
||
<!-- Not obligatory, but suggest a fix or reason for the bug --> | ||
|
||
## Additional context | ||
|
||
<!-- Add any other context about the problem here. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
name: "\U0001F381 Feature Request" | ||
about: Do you have an idea for a new feature? | ||
labels: feature request | ||
--- | ||
|
||
<!-- | ||
Thanks for requesting a feature! | ||
Before opening a new issue, please make sure that we do not have any duplicates already open. | ||
You can ensure this by searching the issue list for this repository. | ||
If there is a duplicate, please close your issue and add a comment to the existing issue instead. | ||
--> | ||
|
||
## Feature description | ||
|
||
<!-- | ||
Provide a detailed description of the feature or improvement you are proposing. | ||
What specific solution would you like? What is the expected behaviour? | ||
Add any other context, screenshots, or code snippets about the feature request here as well. | ||
--> | ||
|
||
## Problem and motivation | ||
|
||
<!-- | ||
Why is this change important to you? What is the problem this feature would solve? | ||
How would you use it? How can it benefit other users? | ||
--> | ||
|
||
## Is this something you're interested in working on | ||
|
||
<!-- Yes or No --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
name: "\u23F1\uFE0F Enhancement" | ||
about: Do you have an idea for an enhancement? | ||
labels: enhancement | ||
--- | ||
|
||
<!-- | ||
Thanks for proposing an enhancement! | ||
Before opening a new issue, please make sure that we do not have any duplicates already open. | ||
You can ensure this by searching the issue list for this repository. | ||
If there is a duplicate, please close your issue and add a comment to the existing issue instead. | ||
--> | ||
|
||
## Current Implementation | ||
|
||
<!-- Describe or point to the current implementation that you would like to see improved --> | ||
|
||
## Suggested Enhancement | ||
|
||
<!-- | ||
Outline the idea of your enhancement, by e.g., describing the algorithm you propose. | ||
You can also create a Pull Request to outline your idea | ||
--> | ||
|
||
## Expected Benefits | ||
|
||
<!-- | ||
Summarize how your enhancement could aid the implementation (performance, readability, memory consumption, battery consumption, etc.). | ||
Please also back up with measurements or give detailed explanations for reduced runtime, memory consumption, etc. | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: "\U00002753 Question" | ||
about: If you have questions about pieces of the code or documentation for this component, please post them here. | ||
labels: question | ||
--- | ||
|
||
<!-- | ||
Thanks for submitting your question! | ||
Before opening a new issue, please make sure that we do not have any duplicates already open. | ||
You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead. | ||
Also, please, have a look at our FAQs and existing questions before opening a new question. | ||
--> | ||
|
||
## Your Question | ||
|
||
<!-- Include details about your question. --> | ||
|
||
* Source File: | ||
* Line(s): | ||
* Question: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# This file provides an overview of code owners in this repository. | ||
|
||
# Each line is a file pattern followed by one or more owners. | ||
# The last matching pattern has the most precedence. | ||
# For more details, read the following article on GitHub: https://help.github.com/articles/about-codeowners/. | ||
|
||
# These are the default owners for the whole content of this repository. The default owners are automatically added as reviewers when you open a pull request, unless different owners are specified in the file. | ||
* @ascheibal |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
# Contributing | ||
|
||
## Code of conduct | ||
|
||
All members of the project community must abide by the [Contributor Covenant, version 2.0](CODE_OF_CONDUCT.md). | ||
Only by respecting each other can we develop a productive, collaborative community. | ||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting [[email protected]](mailto:[email protected]) and/or a project maintainer. | ||
|
||
We appreciate your courtesy of avoiding political questions here. Issues which are not related to the project itself will be closed by our community managers. | ||
|
||
## Engaging in our project | ||
|
||
We use GitHub to manage reviews of pull requests. | ||
|
||
* If you are a new contributor, see: [Steps to Contribute](#steps-to-contribute) | ||
|
||
* If you have a trivial fix or improvement, go ahead and create a pull request, addressing (with `@...`) a suitable maintainer of this repository (see [CODEOWNERS](CODEOWNERS) of the repository you want to contribute to) in the description of the pull request. | ||
|
||
* If you plan to do something more involved, please reach out to us and send an [email](mailto:[email protected]). This will avoid unnecessary work and surely give you and us a good deal of inspiration. | ||
|
||
* Relevant coding style guidelines are available in the respective sub-repositories as they are programming language-dependent. | ||
|
||
## Steps to Contribute | ||
|
||
Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on. This is to prevent duplicated efforts from other contributors on the same issue. | ||
|
||
If you have questions about one of the issues, please comment on them, and one of the maintainers will clarify. | ||
|
||
We kindly ask you to follow the [Pull Request Checklist](#Pull-Request-Checklist) to ensure reviews can happen accordingly. | ||
|
||
## Contributing Code | ||
|
||
You are welcome to contribute code in order to fix a bug or to implement a new feature. | ||
|
||
The following rule governs code contributions: | ||
|
||
* Contributions must be licensed under the [Apache 2.0 License](./LICENSE) | ||
* Newly created files must be opened by an instantiated version of the file 'templates/file-header.txt' | ||
* At least if you add a new file to the repository, add your name into the contributor section of the file NOTICE (please respect the preset entry structure) | ||
|
||
## Contributing Documentation | ||
|
||
You are welcome to contribute documentation to the project. | ||
|
||
The following rule governs documentation contributions: | ||
|
||
* Contributions must be licensed under the same license as code, the [Apache 2.0 License](./LICENSE) | ||
|
||
## Pull Request Checklist | ||
|
||
* Branch from the master branch and, if needed, rebase to the current master branch before submitting your pull request. If it doesn't merge cleanly with master you may be asked to rebase your changes. | ||
|
||
* Commits should be as small as possible while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests). | ||
|
||
* Test your changes as thoroughly as possible before you commit them. Preferably, automate your test by unit/integration tests. If tested manually, provide information about the test scope in the PR description (e.g. “Test passed: Upgrade version from 0.42 to 0.42.23.”). | ||
|
||
* Create _Work In Progress [WIP]_ pull requests only if you need clarification or an explicit review before you can continue your work item. | ||
|
||
* If your patch is not getting reviewed or you need a specific person to review it, you can @-reply a reviewer asking for a review in the pull request or a comment, or you can ask for a review by contacting us via [email](mailto:[email protected]). | ||
|
||
* Post review: | ||
* If a review requires you to change your commit(s), please test the changes again. | ||
* Amend the affected commit(s) and force push onto your branch. | ||
* Set respective comments in your GitHub review to resolved. | ||
* Create a general PR comment to notify the reviewers that your amendments are ready for another round of review. | ||
|
||
## Issues and Planning | ||
|
||
* We use GitHub issues to track bugs and enhancement requests. | ||
|
||
* Please provide as much context as possible when you open an issue. The information you provide must be comprehensive enough to reproduce that issue for the assignee. Therefore, contributors may use but aren't restricted to the issue template provided by the project maintainers. | ||
|
||
* When creating an issue, try using one of our issue templates which already contain some guidelines on which content is expected to process the issue most efficiently. If no template applies, you can of course also create an issue from scratch. | ||
|
||
* Please apply one or more applicable [labels](/../../labels) to your issue so that all community members are able to cluster the issues better. |
Oops, something went wrong.