-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #92 from adobe/dev-v2.0.0
Dev v2.0.0 -> Staging for second snapshot
- Loading branch information
Showing
17 changed files
with
414 additions
and
321 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 |
|---|---|---|
|
|
@@ -2,73 +2,78 @@ | |
|
|
||
| ## 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. | ||
| We as members, contributors, and leaders pledge to make participation in our project and community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, 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 creating a positive environment | ||
| include: | ||
| Examples of behavior that contribute to a positive environment for our project and community 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 | ||
| * 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 by participants include: | ||
| Examples of unacceptable behavior include: | ||
|
|
||
| * The use of sexualized language or imagery and unwelcome sexual attention or | ||
| advances | ||
| * Trolling, insulting/derogatory comments, and personal or political attacks | ||
| * 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 electronic | ||
| address, without explicit permission | ||
| * Other conduct which could reasonably be considered inappropriate in a | ||
| professional setting | ||
| * 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 | ||
|
|
||
| ## 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 are responsible for clarifying and enforcing our standards of acceptable behavior and will 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. | ||
| 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 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. | ||
| This Code of Conduct applies when an individual is representing the project or its community both within project spaces and in public spaces. Examples of representing a project or 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. 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 at [email protected]. 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. | ||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by first contacting the project team. Oversight of Adobe projects is handled by the Adobe Open Source Office, which has final say in any violations and enforcement of this Code of Conduct and can be reached at [email protected]. All complaints will be reviewed and investigated promptly and fairly. | ||
|
|
||
| The project team must respect the privacy and security of the reporter of any incident. | ||
|
|
||
| Project maintainers who do not follow or enforce the Code of Conduct may face temporary or permanent repercussions as determined by other members of the project's leadership or the Adobe Open Source Office. | ||
|
|
||
| ## Enforcement Guidelines | ||
|
|
||
| Project maintainers will follow these Community Impact Guidelines in determining the consequences for any action they deem to be 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 project maintainers describing the violation and why the behavior was unacceptable. A public apology may be requested from the violator before any further involvement in the project by violator. | ||
|
|
||
| **2. Warning** | ||
|
|
||
| Community Impact: A relatively minor violation through a single incident or series of actions. | ||
|
|
||
| Consequence: A written warning from project maintainers that includes stated consequences for continued unacceptable behavior. Violator must refrain from interacting with the people involved for a specified period of time as determined by the project maintainers, including, but not limited to, unsolicited interaction with those enforcing the Code of Conduct through channels such as community spaces and social media. Continued violations may lead to a temporary or permanent ban. | ||
|
|
||
| **3. Temporary Ban** | ||
|
|
||
| Community Impact: A more serious violation of community standards, including sustained unacceptable behavior. | ||
|
|
||
| Consequence: A temporary ban from any 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. Failure to comply with the temporary ban may lead to a permanent ban. | ||
|
|
||
| **4. Permanent Ban** | ||
|
|
||
| Community Impact: Demonstrating a consistent pattern of violation of community standards or an egregious violation of community standards, including, but not limited to, sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. | ||
|
|
||
| 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. | ||
| Consequence: A permanent ban from any interaction with the community. | ||
|
|
||
| ## Attribution | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
| available at [https://contributor-covenant.org/version/1/4][version] | ||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, | ||
| available at [https://contributor-covenant.org/version/2/1][version] | ||
|
|
||
| [homepage]: https://contributor-covenant.org | ||
| [version]: https://contributor-covenant.org/version/1/4/ | ||
| [version]: https://contributor-covenant.org/version/2/1 | ||
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
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 |
|---|---|---|
| @@ -1,53 +1,8 @@ | ||
| # Advertising identifier | ||
|
|
||
| ## Configuration | ||
| To enable advertising identifier features in the sample app, follow these steps: | ||
| 1. Update the value for key `gms_ads_app_id` located in the `secrets.xml` at [aepsdk-edgeidentity-android/code/app/src/main/res/values](../code/app/src/main/res/values/secrets.xml) with a valid Google AdMob app ID. | ||
| - See Google's [quick start reference](https://developers.google.com/admob/android/quick-start) on how to get your AdMob app ID. See step 3 of the [Configure your app](https://developers.google.com/admob/android/quick-start#import_the_mobile_ads_sdk) section for a free public test app ID from Google. | ||
| - Any real key values in the `secrets.xml` file should **not** be committed to the repository. | ||
| 2. By default, the ad ID features are commented out in the sample app. To enable these features, uncomment the implemention code using [find and replace all](https://www.jetbrains.com/help/idea/finding-and-replacing-text-in-project.html#replace_search_string_in_project) to replace all instances of: | ||
| ```java | ||
| /* Ad ID implementation | ||
| ``` | ||
| with: | ||
| ```java | ||
| //* Ad ID implementation | ||
| ``` | ||
| Each code block has a pair of block comments wrapped around it to enable this behavior: | ||
| ```java | ||
| /* Ad ID implementation (pt. 1/4) | ||
| <commented implementation code...> | ||
| /* Ad ID implementation (pt. 1/4) */ | ||
| ``` | ||
|
|
||
| After replacement it will become: | ||
| ```java | ||
| //* Ad ID implementation (pt. 1/4) | ||
| <active implementation code!> | ||
| //* Ad ID implementation (pt. 1/4) */ | ||
| ``` | ||
|
|
||
| For convenience, these are the default find and replace shortcuts in Android Studio: | ||
| [<img src="./assets/find-and-replace-shortcuts.png" alt="Default shortcuts for find and replace" width="500"/>](./assets/find-and-replace-shortcuts.png) | ||
|
|
||
| The shortcut should open a window that looks like the following: | ||
| [<img src="./assets/find-and-replace-all-example.png" alt="Example of find and replace" width="500"/>](./assets/find-and-replace-all-example.png) | ||
| There should be 5 pairs of special comment blocks (10 total matches) across two files: | ||
| `app/build.gradle`, `CustomIdentityFragment.kt`, and `SharedViewModel.kt` | ||
|
|
||
| 3. With the implementation code and gradle files uncommented with new dependencies, sync the project with the Gradle file changes using: File -> Sync Project with Gradle Files | ||
|
|
||
| [<img src="./assets/sync-project-gradle-example.png" alt="Example of find and replace" width="500"/>](./assets/sync-project-gradle-example.png) | ||
|
|
||
| The app should now be properly configured to use advertising identifier features. | ||
|
|
||
| To **disable** these features, follow these steps: | ||
| 1. [Find and replace](https://www.jetbrains.com/help/idea/finding-and-replacing-text-in-project.html#replace_search_string_in_project) all instances of: | ||
| ```java | ||
| //* Ad ID implementation | ||
| ``` | ||
| with: | ||
| ```java | ||
| /* Ad ID implementation | ||
| ``` | ||
| 2. Sync Project with Gradle files using: File -> Sync Project with Gradle Files | ||
| # Edge Identity extension documentation | ||
|
|
||
| ## Contents | ||
| - [Getting started](getting-started.md) | ||
| - [API reference](api-reference.md) | ||
| - [Getting started with the test app](getting-started-test-app.md) | ||
| - [Troubleshooting guide](troubleshooting-guide.md) | ||
| - [Frequently asked questions](frequently-asked-questions.md) |
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
Oops, something went wrong.