Skip to content

Commit

Permalink
Configure repository (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
StaehliJ authored May 23, 2023
1 parent d05134b commit 032b2cb
Show file tree
Hide file tree
Showing 7 changed files with 245 additions and 0 deletions.
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
name: 🐞 Bug report
description: File a bug report
labels: ["bug", "triage"]
body:
- type: textarea
id: description
attributes:
label: Description of the problem
description: Describe the issue you encountered as precisely as possible.
validations:
required: true
- type: textarea
id: trace
attributes:
label: Relevant stack trace or log output
description: Include a crash stack trace or a log output if available.
render: shell
- type: dropdown
id: reproducibility
attributes:
label: Reproducibility
description: Evaluate how easy it is to reproduce the issue.
options:
- Always
- Difficult
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: Include step-by-step instructions to reproduce the issue.
placeholder: 1. …
validations:
required: true
- type: input
id: version
attributes:
label: Library version
description: Version of the library which is affected.
placeholder: ex. 1.2.3
validations:
required: true
- type: input
id: system
attributes:
label: Operating system
description: Operating system(s) and version(s) you used.
placeholder: ex. Android 12, Android SDK 23
validations:
required: true
- type: textarea
id: sample
attributes:
label: Code sample
description: Attach a code sample reproducing the issue if possible.
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: >
Please search to see if an
[issue](https://github.com/SRGSSR/srgdataprovider-android/issues?q=is%3Aissue)
already exists for the bug you encountered.
options:
- label: >
I have searched existing issues and found no similar bug report.
required: true
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
blank_issues_enabled: false
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
name: 💡 Feature request
description: Request a feature or submit an idea you have.
labels: ["enhancement", "triage"]
body:
- type: textarea
id: use_case
attributes:
label: Use case description
description: Describe your use case in more detail.
validations:
required: true
- type: textarea
id: acceptance_criteria
attributes:
label: Acceptance criteria
description: Provide us with a few acceptance criteria if possible.
- type: textarea
id: solution
attributes:
label: Proposed solution
description: >
Propose a solution if you have an idea how the feature could be
implemented.
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: >
Describe any alternative solutions you might consider applicable.
- type: checkboxes
attributes:
label: Is there an existing similar feature request?
options:
- label: >
I have searched existing
[features](https://github.com/SRGSSR/pillarbox-android/issues?q=is%3Aissue+label%3Aenhancement+)
and found no similar request.
required: true
- label: >
I have browsed the available API and found no way to achieve
the use case I described.
required: true
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: 💭 Question
description: Ask us for guidance or help.
labels: ["question", "triage"]
body:
- type: textarea
id: description
attributes:
label: Detailed question
description: Please develop your question in further detail.
validations:
required: true
- type: checkboxes
attributes:
label: Can your answer be found elsewhere?
options:
- label: >
I have searched existing
[issues](https://github.com/SRGSSR/srgdataprovider-android/issues?q=is%3Aissue+label%3Aquestion+)
and found no similar question.
required: true
- label: >
I have browsed the available documentation and found no answer
to my question.
required: true
46 changes: 46 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Contributing

Thank you very much for your interest in contributing to our project! As a public service company, we want to shape a product that better matches our user needs and desires. Ideas or direct contributions are therefore warmly welcome and will be considered with great care, provided they fulfill a few requirements listed in this document. Please read it first before you decide to contribute.

## Purpose

Our development team is small, our ability to quickly evaluate a need or a code submission is therefore critical. Please follow the present contributing guidelines so that we can efficiently consider your proposal. You should also read or our [code of conduct](CODE_OF_CONDUCT.md), providing a few guidelines to keep interactions as respectful as possible.

## Contributions we are looking for

Any kind of contribution is welcome, as long as it improves the overall quality of our product, for example:

* Requests for new features or ideas.
* Bug reports or fixes.
* Documentation improvements.
* Translation improvements.

Contributions can either take the form of simple issues where you describe the problem you face or what you would like to see in our products. If you feel up to the challenge, you can even submit code in the form of pull requests which our team will review.

## Contributions we are not looking for

Requests which are too vague or not related to our product will not be taken into account. We also have no editorial influence, any issue related to the content available on our platform will simply be closed.

## Making a contribution

You can use issues to report bugs, submit ideas or request features. People with a programming background can also submit changes directly via pull requests. Creating issues or pull requests requires you to own or [open](https://github.com/join) a GitHub account.

If you are not sure about the likelihood of a change you propose to be accepted, please open an issue first. We can discuss it there, especially whether it is compatible with our product or not. This way you can avoid creating an entire pull request we will never be able to merge.

Templates are available when you want to contribute:

* [Issues](https://github.com/SRGSSR/srgdataprovider-android/issues/new/choose): Please follow our issue template. You can omit information which does not make sense but, in general, the more details you can provide, the better. This ensures we can quickly reproduce the problem you are facing, increasing the likelihood we can fix it.
* [Pull requests](https://github.com/SRGSSR/srgdataprovider-android/compare): Please follow our code conventions, test your code well, and write unit tests when this makes sense. We will review your work and, if successful, merge it back into the main development branch.

## Code conventions

We currently have no formal code conventions, but we try to keep our codebase consistent. In general, having a look at the code itself should be enough for you to discover how you should write your changes.

## Code review

Pull requests, once complete, can be submitted for review by our team. Depending on the complexity of the involved changes, a few iterations might be needed. Once a pull request has been approved, it will be rebased, merged back into the development trunk and delivered with the next release.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) SRG SSR

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.

0 comments on commit 032b2cb

Please sign in to comment.