Merge pull request #2 from CameraKit/develop

Initial Release (v1.0.0)

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# 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, 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 at contact@camerakit.io. 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/

.github/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Contributing
+
+We love pull requests from everyone. By participating in this project, you
+agree to abide by the CameraKit [code of conduct].
+
+[code of conduct]: CODE-OF-CONDUCT.md
+
+Fork, then clone the repo:
+
+    git clone https://github.com/CameraKit/camerakit-ios
+
+Make your change. Add tests for your change. Make the tests pass.
+
+Push to your fork and [submit a pull request][pr].
+
+[pr]: https://github.com/CameraKit/camerakit-ios/pulls
+
+At this point you're waiting on us. We like to at least comment on pull requests
+within three business days (and, typically, one business day). We may suggest
+some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted:
+
+* Write tests.
+* Follow our [style guide][style].
+* Write a [good commit message][commit].
+
+[style]: TBD: https://google.github.io/styleguide/javaguide.html
+[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,97 @@
+<!--
+  PLEASE DON'T DELETE THIS TEMPLATE UNTIL YOU HAVE READ THE FIRST SECTION.
+-->
+
+### Is this a bug report?
+
+(write your answer here)
+
+<!--
+  If you answered "Yes":
+
+    We expect that it will take you about 30 minutes to produce a high-quality bug report.
+    While this may seem like a lot, putting care into issues helps us fix them faster.
+    For bug reports, it is REQUIRED to fill the rest of this template, or the issue will be closed.
+
+  If you answered "No":
+
+    We use GitHub Issues exclusively for tracking bugs in CameraKit. If you're looking for help,
+    the Community page at https://github.com/wonderkiln/CameraKit-ios list various resources
+    that should help you get started.
+
+  Now scroll below!
+-->
+
+### Have you read the [Contributing Guidelines](CONTRIBUTING.md)?
+
+(Write your answer here.)
+
+### Environment
+
+(Please include the following information along with any other relevant environment details.)
+
+CameraKit Version:
+
+iOS Device:
+
+iOS Version:
+
+### Steps to Reproduce
+
+<!--
+  How would you describe your issue to someone who doesn’t know you or your project?
+  Try to write a sequence of steps that anybody can repeat to see the issue.
+  Be specific! If the bug cannot be reproduced, your issue may be closed.
+-->
+
+(Write your steps here:)
+
+1.
+2.
+3.
+
+### Expected Behavior
+
+<!--
+  How did you expect your project to behave?
+  It’s fine if you’re not sure your understanding is correct.
+  Just write down what you thought would happen.
+-->
+
+(Write what you thought would happen.)
+
+### Actual Behavior
+
+<!--
+  Did something go wrong?
+  Is something broken, or not behaving as you expected?
+  Describe this section in detail, and attach screenshots if possible.
+  Don't just say "it doesn't work"!
+-->
+
+(Write what happened. Add screenshots!)
+
+### Reproducible Demo
+
+<!--
+  Please share a project that reproduces the issue.
+-->
+
+(Paste the link to an example project and exact instructions to reproduce the issue.)
+
+(Include your CameraKit setup and usage.)
+<!--
+  What happens if you skip this step?
+
+  Someone will read your bug report, and maybe will be able to help you,
+  but it’s unlikely that it will get much attention from the team. Eventually,
+  the issue will likely get closed in favor of issues that have reproducible demos.
+
+  Please remember that:
+
+    * Issues without reproducible demos have a very low priority.
+    * The person fixing the bug would have to do that anyway. Please be respectful of their time.
+    * You might figure out the issues yourself as you work on extracting it.
+
+  Thanks for helping us help you!
+-->

.github/PULL_REQUEST_TEMPALTE.md

@@ -0,0 +1,30 @@
+<!--
+Thank you for sending the PR! We appreciate you spending the time to work on these changes.
+-->
+
+## Proposed changes
+
+Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.
+
+## Types of changes
+
+What types of changes does your code introduce to CameraKit?
+_Put an `x` in the boxes that apply_
+
+- [ ] Bugfix (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)
+
+## Checklist
+
+_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
+
+- [ ] I have read the [CONTRIBUTING](/CONTRIBUTING.md) doc
+- [ ] Lint and unit tests pass locally with my changes
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] I have added necessary documentation (if appropriate)
+- [ ] Any dependent changes have been merged and published in downstream modules
+
+## Further comments
+
+If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

.github/TESTING_PROCEDURES.md

@@ -0,0 +1,57 @@
+# CameraKit Testing Procedures
+
+For each release we plan to run all code changes through a specific flow and test regiment, on varying devicews. THe report of these tests will be reported via a comment or in the PR Header ahead of any and all merges.
+
+## Tests
+### Test Photo Capture (Portrait)
+
+- Open CameraKit
+  - Take single photo
+    - Verify photo is created and saved as Portrait Photo
+    - Verify photo is in-focus, and error free
+
+### Test Photo Capture (Landscape)
+
+- Open CameraKit
+  - Take single photo
+    - Verify photo is created and saved as Landscape Photo
+    - Verify photo is in-focus, and error free
+
+### Test Orientation Capture
+
+- Change Orientation to 90, 180, 270, 0 (with orientation lock OFF)
+  - Confirm Preview Updates properly for each orietantation
+  - Capture Photo for each orientation, confirm result matches preview
+
+### Test Orientation Capture w/ Orientation Lock ON
+
+- Change Orientation to 90, 180, 270, 0 (with orientation lock ON)
+  - Confirm Preview Updates properly for each orietantation
+  - Capture Photo for each orientation, confirm result matches preview
+
+### Engage Camera Controls and Take Photo (Portrait)
+
+- Open CameraKit
+  - Tap to Focus and Take Photo
+    - Confirm preview focuses correctly
+    - COnfirm saved photo matches preview
+  - Pinch to Zoom (In + Out) and Take Photo
+    - Confirm preview zooms correctly
+    - COnfirm saved photo matches preview
+  - Take single photo
+    - Verify photo is created and saved as Landscape Photo
+    - Verify photo is in-focus, and error free
+
+### Test Camera under Rapid Fire
+
+- Open CameraKit
+  - Take succesive photos (30 within 30s)
+    - Verify all 30 photos are created and saved
+    - Verify each photo appears without error
+
+
+## Devices being tested on
+- iPhone X
+- iPhone XS
+
+Want to request a device? Make a issue in Github! =)

.github/issue-labels.json

@@ -0,0 +1,22 @@
+[
+  { "name": "CLA: Signed", "color": "#009800" },
+  { "name": "CLA: Unsigned", "color": "#e11d21" },
+  { "name": "Priority: Low", "color": "#009800" },
+  { "name": "Priority: Medium", "color": "#fbca04" },
+  { "name": "Priority: High", "color": "#eb6420" },
+  { "name": "Priority: Critical", "color": "#e11d21" },
+  { "name": "Status: Abandoned", "color": "#000000" },
+  { "name": "Status: Accepted", "color": "#009800" },
+  { "name": "Status: Available", "color": "#bfe5bf" },
+  { "name": "Status: Blocked", "color": "#e11d21" },
+  { "name": "Status: Completed", "color": "#006b75" },
+  { "name": "Status: In Progress", "color": "#cccccc" },
+  { "name": "Status: On Hold", "color": "#e11d21" },
+  { "name": "Status: Pending", "color": "#fef2c0" },
+  { "name": "Status: Review Needed", "color": "#fbca04" },
+  { "name": "Status: Revision Needed", "color": "#e11d21" },
+  { "name": "Type: Bug", "color": "#e11d21" },
+  { "name": "Type: Maintenance", "color": "#fbca04" },
+  { "name": "Type: Enhancement", "color": "#84b6eb" },
+  { "name": "Type: Question", "color": "#cc317c" }
+]

.gitignore

@@ -61,3 +61,5 @@ fastlane/test_output
 # https://github.com/johnno1962/injectionforxcode
 
 iOSInjectionProject/
+
+.DS_Store