Skip to content
This repository has been archived by the owner on Jul 27, 2024. It is now read-only.

Commit

Permalink
Add community health files
Browse files Browse the repository at this point in the history
  • Loading branch information
ClaudiuGeorgiu committed Dec 12, 2020
1 parent aa2becd commit 4a18844
Show file tree
Hide file tree
Showing 12 changed files with 445 additions and 9 deletions.
76 changes: 76 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
name: "\U0001F41E Bug report"
about: "Create a bug report to help us improve PlaystoreDownloader"
title: ""
labels: "bug"
assignees: ""
---

<!--
Thank you for reporting a problem with PlaystoreDownloader.
Please fill in as much of the template below as you can. If you leave out information, we can't help you as well.
NOTE:
* if you're including code snippets/logs, please format them properly (see https://help.github.com/github/writing-on-github/basic-writing-and-formatting-syntax#quoting-code);
* blocks starting with `< !--` and ending with `-- >` (without spaces) are treated as comments and won't be rendered, so please don't edit the text inside these blocks since your modifications won't be visible. If you want the text to be visible, remove `< !--` and `-- >` tags.
-->



### Prerequisites

Before opening this issue, I tried the following steps:

<!-- Please put an x between the brackets of each line that applies below, so that [ ] becomes [x] (without leaving spaces around the x) -->

* [ ] Installed the tool in a way [described in the readme](https://github.com/ClaudiuGeorgiu/PlaystoreDownloader#-installation) and configured the [account/credentials](https://github.com/ClaudiuGeorgiu/PlaystoreDownloader#-configuration)

* [ ] Made sure the download works when using the same account on a real device/emulator

* [ ] Checked for [existing similar issues on GitHub](https://github.com/issues?utf8=✓&q=is%3Aissue+repo%3AClaudiuGeorgiu/PlaystoreDownloader)



### Description

<!-- A clear and concise description of what the issue is (insert text below this line) -->



### Steps to reproduce

1. <!-- First Step -->
2. <!-- Second Step -->
3. <!-- And so on… -->


**Expected behavior:**

<!-- A clear and concise description of what you expected to happen (insert text below this line) -->


**Actual behavior:**

<!-- What actually happens (insert text below this line) -->

```
paste here the complete error message, including the command that generated the error
```



### Versions

<!-- Please fill all the applicable fields below to help us replicate the problem -->

* **Installation mode** (e.g., from source or with Docker):
* **PlaystoreDownloader version** (e.g., commit c35f8bc):
* **OS** (e.g., Ubuntu 18.04):
* **Python version** (e.g., 3.8.6):



### Additional information

<!-- Any additional information, configuration or data that might be necessary to reproduce the issue (insert text below this line) -->
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: "\U0001F680 Feature request"
about: "Suggest an idea to help us improve PlaystoreDownloader"
title: ""
labels: "enhancement"
assignees: ""
---

<!--
Thank you for your interest in improving PlaystoreDownloader.
Please describe the new feature(s) you would like to see in PlaystoreDownloader.
NOTE:
* if you're including code snippets/logs, please format them properly (see https://help.github.com/github/writing-on-github/basic-writing-and-formatting-syntax#quoting-code);
* blocks starting with `< !--` and ending with `-- >` (without spaces) are treated as comments and won't be rendered, so please don't edit the text inside these blocks since your modifications won't be visible. If you want the text to be visible, remove `< !--` and `-- >` tags.
-->



### Is this feature request related to a problem?

<!-- A clear and concise description of what the problem is, e.g., I have an issue when... (insert text below this line) -->



### Proposed solution

<!-- A clear and concise description of what you want to happen (describe your solution below this line) -->



### Additional context

<!-- Is there anything else you can add about the feature proposal? (insert text below this line) -->



### Would you like to submit a pull request for this feature?

<!-- Yes/No/I would like to submit a PR but I need further assistance with... (insert text below this line) -->
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/general_question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: "\U0001F4AC Question"
about: "Ask a general question about PlaystoreDownloader"
title: ""
labels: "question"
assignees: ""
---

<!--
Thank you for your interest in PlaystoreDownloader.
You can use this issue for anything other than bug reports and feature requests. Please provide as much information as needed to help us answer your question(s).
NOTE:
* if you're including code snippets/logs, please format them properly (see https://help.github.com/github/writing-on-github/basic-writing-and-formatting-syntax#quoting-code);
* blocks starting with `< !--` and ending with `-- >` (without spaces) are treated as comments and won't be rendered, so please don't edit the text inside these blocks since your modifications won't be visible. If you want the text to be visible, remove `< !--` and `-- >` tags.
-->
51 changes: 51 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<!--
Thank you for your interest in improving PlaystoreDownloader.
Please describe the bug fix(es) and/or new feature(s) you are proposing.
NOTE:
* if you're including code snippets/logs, please format them properly (see https://help.github.com/github/writing-on-github/basic-writing-and-formatting-syntax#quoting-code);
* blocks starting with `< !--` and ending with `-- >` (without spaces) are treated as comments and won't be rendered, so please don't edit the text inside these blocks since your modifications won't be visible. If you want the text to be visible, remove `< !--` and `-- >` tags.
-->



### Description

<!-- Please include relevant motivation and context. If this PR fixes a bug or implements a feature request, be sure to include a link to that issue (insert text below this line) -->



### Proposed solution

<!-- A clear and concise summary of the proposed changes (describe your solution below this line) -->



### Type of change

<!-- Please put an x between the brackets of each line that applies below, so that [ ] becomes [x] (without leaving spaces around the x) -->

* [ ] Bug fix (non-breaking change which fixes an issue)
* [ ] New feature (non-breaking change which adds functionality)
* [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
* [ ] Other (e.g., refactoring, documentation etc.)



### Additional context

<!-- Is there anything else you can add about the PR? E.g., why you chose the solution you did, what alternatives you considered etc. (insert text below this line) -->



### Checklist

<!-- Please put an x between the brackets of each line that applies below, so that [ ] becomes [x] (without leaving spaces around the x) -->

* [ ] I have read the [contributing](https://github.com/ClaudiuGeorgiu/PlaystoreDownloader/blob/master/docs/CONTRIBUTING.md) guidelines
* [ ] I have performed a self-review of my own code (added comments, corrected misspellings etc.)
* [ ] My code follows the style guidelines of this project
* [ ] I have made corresponding changes to the documentation (if appropriate)
* [ ] I have added tests that prove my fix is effective or that my feature works
* [ ] New and existing tests pass locally with my changes
29 changes: 29 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: CodeQL

on:
push:
pull_request:
schedule:
- cron: '30 23 * * 5'

jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest

strategy:
fail-fast: false
matrix:
language: [ python ]

steps:
- name: Checkout repository
uses: actions/checkout@v2

- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
languages: ${{ matrix.language }}

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1
3 changes: 2 additions & 1 deletion .idea/webResources.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
the Google Play Store. After an initial (one-time) configuration, applications can be
downloaded by specifying their package name.

**_This project is intended for learning purposes only and is not affiliated with Google
in any way._**
***This project is intended for learning purposes only and is not affiliated with Google
in any way***.



Expand Down Expand Up @@ -173,9 +173,9 @@ download the applications):

- temporarily unlock access to your account (<https://accounts.google.com/DisplayUnlockCaptcha>)

_Note that you will be able to download only the applications compatible with the device
*Note that you will be able to download only the applications compatible with the device
corresponding to the aforementioned **ANDROID ID** and further limitations may influence
the total number of applications available for download_.
the total number of applications available for download*.



Expand Down Expand Up @@ -274,7 +274,7 @@ downloaded application.
application (if there are any). See
[Dynamic Delivery](https://developer.android.com/guide/app-bundle/dynamic-delivery)
for more information. The additional files will be saved in the same directory as the
downloaded application. _Note: this feature used to work but currently seems broken._
downloaded application. *Note: this feature used to work but currently seems broken*.

* `-c CREDENTIALS` is used to set the path to the JSON configuration file containing
the Google Play Store credentials. If not specified, by default the tool will try to
Expand All @@ -290,16 +290,17 @@ by using `-t "LABEL"` the final name of the downloaded application will look lik
`[LABEL] filename.apk`. Note: the tag is applied only to the main application, the
additional files won't have any tag added to the file name.

_Note that currently only the command line interface is configurable with the above
*Note that currently only the command line interface is configurable with the above
arguments, the web interface will ask only for a package name and will use the default
values for all the other parameters._
values for all the other parameters*.



## ❱ Contributing

Questions, bug reports and pull requests are welcome on GitHub at
[https://github.com/ClaudiuGeorgiu/PlaystoreDownloader](https://github.com/ClaudiuGeorgiu/PlaystoreDownloader).
[https://github.com/ClaudiuGeorgiu/PlaystoreDownloader](https://github.com/ClaudiuGeorgiu/PlaystoreDownloader)
(see [contributing](https://github.com/ClaudiuGeorgiu/PlaystoreDownloader/blob/master/docs/CONTRIBUTING.md)).



Expand Down
76 changes: 76 additions & 0 deletions docs/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant 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, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, 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. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
Loading

0 comments on commit 4a18844

Please sign in to comment.