Skip to content

Commit c016672

Browse files
authoredAug 26, 2017
Create CONTRIBUTING.md
1 parent 60d6bfd commit c016672

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed
 

‎CONTRIBUTING.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Contributing to `TOPasscodeViewController`
2+
3+
Thanks so much for your interest in `TOPasscodeViewController`! It makes me incredibly happy to hear that others have not just found it useful, but are eager to help contribute to it.
4+
5+
## Submitting a Pull Request
6+
At this point, this library is pretty much a delicate house of cards. When modifying any of the code involved with the UI or layout, a lot of manual testing needs to be done to ensure that no regressions were introduced.
7+
8+
If you've added or changed a feature that directly involves any UI layout, please test the following to ensure nothing has broken.
9+
* Presenting and dismissing the view controller in both portrait and landscape modes.
10+
* Presenting the view controller, rotating the device and then dismissing from the new orientation.
11+
* Presenting the view controller, then enabling split-screen on an iPad.
12+
* Changing the split-screen window sizes on iPad.
13+
14+
If possible, please file an issue before filing a PR to discuss the feature you'd like to add. To ensure the quality of this view controller library doesn't dip, I plan to be very strict about the level of reliability and thoroughness of any code submitted through a PR. :)
15+
16+
## Submitting an Issue
17+
I've included all of the essential tips for filing comprehensive issues directly in the [issues template](/TimOliver/TOPasscodeViewController/blob/master/ISSUE_TEMPLATE.md). Please read that document and follow it as closely as you can when filing new issues.
18+
19+
---
20+
21+
Thanks again for your interest in `TOPasscodeViewController`! I hope you've found the library useful in your apps!

0 commit comments

Comments
 (0)
Please sign in to comment.