-
Notifications
You must be signed in to change notification settings - Fork 0
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 2854b78
Showing
5 changed files
with
303 additions
and
0 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
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. | ||
* @kreincke |
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,133 @@ | ||
|
||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
We as members, contributors, and leaders pledge to make participation in our | ||
community a harassment-free experience for everyone, regardless of age, body | ||
size, visible or invisible disability, ethnicity, sex characteristics, gender | ||
identity and expression, level of experience, education, socio-economic status, | ||
nationality, personal appearance, race, caste, color, religion, or sexual | ||
identity and orientation. | ||
|
||
We pledge to act and interact in ways that contribute to an open, welcoming, | ||
diverse, inclusive, and healthy community. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to a positive environment for our | ||
community include: | ||
|
||
* Demonstrating empathy and kindness toward other people | ||
* Being respectful of differing opinions, viewpoints, and experiences | ||
* Giving and gracefully accepting constructive feedback | ||
* Accepting responsibility and apologizing to those affected by our mistakes, | ||
and learning from the experience | ||
* Focusing on what is best not just for us as individuals, but for the overall | ||
community | ||
|
||
Examples of unacceptable behavior include: | ||
|
||
* The use of sexualized language or imagery, and sexual attention or advances of | ||
any kind | ||
* Trolling, insulting or derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or email address, | ||
without their explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Enforcement Responsibilities | ||
|
||
Community leaders are responsible for clarifying and enforcing our standards of | ||
acceptable behavior and will take appropriate and fair corrective action in | ||
response to any behavior that they deem inappropriate, threatening, offensive, | ||
or harmful. | ||
|
||
Community leaders have the right and responsibility to remove, edit, or reject | ||
comments, commits, code, wiki edits, issues, and other contributions that are | ||
not aligned to this Code of Conduct, and will communicate reasons for moderation | ||
decisions when appropriate. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all community spaces, and also applies when | ||
an individual is officially representing the community in public spaces. | ||
Examples of representing our community include using an official e-mail address, | ||
posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported to the community leaders responsible for enforcement at | ||
[INSERT CONTACT METHOD]. | ||
All complaints will be reviewed and investigated promptly and fairly. | ||
|
||
All community leaders are obligated to respect the privacy and security of the | ||
reporter of any incident. | ||
|
||
## Enforcement Guidelines | ||
|
||
Community leaders will follow these Community Impact Guidelines in determining | ||
the consequences for any action they deem in violation of this Code of Conduct: | ||
|
||
### 1. Correction | ||
|
||
**Community Impact**: Use of inappropriate language or other behavior deemed | ||
unprofessional or unwelcome in the community. | ||
|
||
**Consequence**: A private, written warning from community leaders, providing | ||
clarity around the nature of the violation and an explanation of why the | ||
behavior was inappropriate. A public apology may be requested. | ||
|
||
### 2. Warning | ||
|
||
**Community Impact**: A violation through a single incident or series of | ||
actions. | ||
|
||
**Consequence**: A warning with consequences for continued behavior. No | ||
interaction with the people involved, including unsolicited interaction with | ||
those enforcing the Code of Conduct, for a specified period of time. This | ||
includes avoiding interactions in community spaces as well as external channels | ||
like social media. Violating these terms may lead to a temporary or permanent | ||
ban. | ||
|
||
### 3. Temporary Ban | ||
|
||
**Community Impact**: A serious violation of community standards, including | ||
sustained inappropriate behavior. | ||
|
||
**Consequence**: A temporary ban from any sort of interaction or public | ||
communication with the community for a specified period of time. No public or | ||
private interaction with the people involved, including unsolicited interaction | ||
with those enforcing the Code of Conduct, is allowed during this period. | ||
Violating these terms may lead to a permanent ban. | ||
|
||
### 4. Permanent Ban | ||
|
||
**Community Impact**: Demonstrating a pattern of violation of community | ||
standards, including sustained inappropriate behavior, harassment of an | ||
individual, or aggression toward or disparagement of classes of individuals. | ||
|
||
**Consequence**: A permanent ban from any sort of public interaction within the | ||
community. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
version 2.1, available at | ||
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. | ||
|
||
Community Impact Guidelines were inspired by | ||
[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. | ||
|
||
For answers to common questions about this code of conduct, see the FAQ at | ||
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at | ||
[https://www.contributor-covenant.org/translations][translations]. | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html | ||
[Mozilla CoC]: https://github.com/mozilla/diversity | ||
[FAQ]: https://www.contributor-covenant.org/faq | ||
[translations]: https://www.contributor-covenant.org/translations |
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,73 @@ | ||
# Contributing | ||
|
||
## Code of conduct | ||
|
||
All members of the project community must abide by the [Contributor Covenant, version 2.1](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 [MIT License](./LICENSE) | ||
* Newly created files must be opened by an instantiated version to 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 [MIT License](./LICENSE) | ||
|
||
## Pull Request Checklist | ||
|
||
* Branch from the main branch and, if needed, rebase to the current main branch before submitting your pull request. If it doesn't merge cleanly with main 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. |
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,21 @@ | ||
|
||
MIT License | ||
|
||
https://opensource.org/licenses/MIT | ||
|
||
Copyright 2022 Deutsche Telekom AG | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software | ||
and associated documentation files (the "Software"), to deal in the Software without restriction, | ||
including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, | ||
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, | ||
subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial | ||
portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING | ||
BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, | ||
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
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,68 @@ | ||
<h1 align="center"> | ||
GeofenceTester iOS | ||
</h1> | ||
|
||
<p align="center"> | ||
<a href="/../../commits/" title="Last Commit"><img src="https://img.shields.io/github/last-commit/telekom/geo-test-ios?style=flat"></a> | ||
<a href="/../../issues" title="Open Issues"><img src="https://img.shields.io/github/issues/telekom/geo-test-ios?style=flat"></a> | ||
<a href="./LICENSE" title="License"><img src="https://img.shields.io/badge/License-MIT-green.svg?style=flat"></a> | ||
</p> | ||
|
||
<p align="center"> | ||
<a href="#development">Development</a> • | ||
<a href="#documentation">Documentation</a> • | ||
<a href="#support-and-feedback">Support</a> • | ||
<a href="#how-to-contribute">Contribute</a> • | ||
<a href="#licensing">Licensing</a> | ||
</p> | ||
|
||
The goal of this project is ... _TBD_ | ||
|
||
## About this component | ||
|
||
_TBD_ | ||
|
||
## Development | ||
|
||
_TBD_ | ||
|
||
### Build | ||
|
||
_TBD_ | ||
|
||
## Code of Conduct | ||
|
||
This project has adopted the [Contributor Covenant](https://www.contributor-covenant.org/) in version 2.0 as our code of conduct. Please see the details in our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). All contributors must abide by the code of conduct. | ||
|
||
## Working Language | ||
|
||
We decided to apply _English_ as the primary project language. | ||
|
||
Consequently, all content will be made available primarily in English. We also ask all interested people to use English as language to create issues, in their code (comments, documentation etc.) and when you send requests to us. The application itself and all end-user facing content will be made available in other languages as needed. | ||
|
||
## Documentation | ||
|
||
The full documentation for this project can be found in _TBD_ | ||
|
||
## Support and Feedback | ||
|
||
The following channels are available for discussions, feedback, and support requests: | ||
|
||
| Type | Channel | | ||
| ------------------------ | ------------------------------------------------------ | | ||
| **Issues** | <a href="/../../issues/new/choose" title="General Discussion"><img src="https://img.shields.io/github/issues/telekom/geo-test-ios?style=flat-square"></a> </a> | | ||
| **Other Requests** | <a href="mailto:[email protected]" title="Email Open Source Team"><img src="https://img.shields.io/badge/email-Open%20Source%20Team-green?logo=mail.ru&style=flat-square&logoColor=white"></a> | | ||
|
||
## How to Contribute | ||
|
||
Contribution and feedback is encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](./CONTRIBUTING.md). By participating in this project, you agree to abide by its [Code of Conduct](./CODE_OF_CONDUCT.md) at all times. | ||
|
||
## Licensing | ||
|
||
Copyright (c) 2022 Deutsche Telekom AG. | ||
|
||
Licensed under the **MIT License** (the "License"); you may not use this file except in compliance with the License. | ||
|
||
You may obtain a copy of the License by reviewing the file [LICENSE](./LICENSE) in the repository. | ||
|
||
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the [LICENSE](./LICENSE) for the specific language governing permissions and limitations under the License. |