-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add pod spec and separate sources from examples (#11)
- Loading branch information
1 parent
beac8a6
commit aaa5657
Showing
20 changed files
with
117 additions
and
12 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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Change Log | ||
All notable changes to SuggestionRow will be documented in this file. | ||
|
||
### [1.0.0](https://github.com/EurekaCommunity/SuggestionRow/releases/tag/1.0.0) | ||
|
||
* This is the initial version. It supports Eureka 3.0 and Swift 3 | ||
|
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 |
---|---|---|
@@ -0,0 +1,56 @@ | ||
Contributing Guidelines | ||
-------------------------------------------------- | ||
|
||
This document provides general guidelines about how to contribute to the project. Keep in mind these important things before you start contributing. | ||
|
||
### Reporting issues | ||
|
||
* Use [github issues](https://github.com/EurekaCommunity/SuggestionRow/issues) to report a bug. | ||
* Before creating a new issue: | ||
* Make sure you are using the [latest release](https://github.com/EurekaCommunity/SuggestionRow/releases). | ||
* Check if the issue was [already reported or fixed](https://github.com/EurekaCommunity/SuggestionRow/issues?utf8=%E2%9C%93&q=is%3Aissue). Notice that it may not be released yet. | ||
* If you found a match add a brief comment "I have the same problem" or "+1". This helps prioritize the issues addressing the most common and critical first. If possible add additional information to help us reproduce and fix the issue. Please use your best judgement. | ||
* Reporting issues: | ||
* Please include the following information to help maintainers to fix the problem faster: | ||
* Xcode version you are using. | ||
* iOS version you are targeting. | ||
* Full Xcode console output of stack trace or code compilation error. | ||
* Any other additional detail you think it would be useful to understand and solve the problem. | ||
|
||
|
||
### Pull requests | ||
|
||
The easiest way to start contributing is searching open issues by `help wanted` tag. We also add a `difficulty` tag (difficulty: easy, difficulty: moderate, difficulty: hard) in order to give an idea of how complex it can be to implement the feature according maintainers project experience. | ||
|
||
* Add test coverage to the feature or fix. We only accept new feature pull requests that have related test coverage. This allows us to keep the library stable as we move forward. | ||
* Remember to document the new feature. We do not accept new feature pull requests without its associated documentation. | ||
* In case of a new feature please update the example project showing the feature. | ||
* Please only one fix or feature per pull request. This will increase the chances your feature will be merged. | ||
|
||
|
||
###### Suggested git workflow to contribute | ||
|
||
1. Fork the SuggestionRow repository. | ||
2. Clone your forked project into your developer machine: `git clone [email protected]:<your-github-username>/SuggestionRow.git` | ||
3. Add the original project repo as upstream repository in your forked project: `git remote add upstream [email protected]:EurekaCommunity/SuggestionRow.git` | ||
4. Before starting a new feature make sure your forked master branch is synchronized upstream master branch. Considering you do not mere your pull request into master you can run: `git checkout master` and then `git pull upstream master`. Optionally `git push origin master`. | ||
5. Create a new branch. Note that the starting point is the upstream master branch HEAD. `git checkout -b my-feature-name` | ||
6. Stage all your changes `git add .` and commit them `git commit -m "Your commit message"` | ||
7. Make sure your branch is up to date with upstream master, `git pull --rebase upstream master`, resolve conflicts if necessary. This will move your commit to the top of git stack. | ||
8. Squash your commits into one commit. `git rebase -i HEAD~6` considering you did 6 commits. | ||
9. Push your branch into your forked remote repository. | ||
10. Create a new pull request adding any useful comment. | ||
|
||
|
||
###### Code style and conventions | ||
|
||
We try to follow our [swift style guide](https://github.com/EurekaCommunity/Swift-Style-Guide). Following it is not strictly necessary to contribute and to have a pull request accepted but project maintainers try to follow it. We would love to hear your ideas to improve our code style and conventions. Feel free to contribute. | ||
|
||
|
||
### Feature proposal | ||
|
||
We would love to hear your ideas and make a discussions about it. | ||
|
||
* Use github issues to make feature proposals. | ||
* Before submitting your proposal make sure there is no similar feature request. If you found a match feel free to join the discussion or just add a brief "+1" if you think the feature is worth implementing. | ||
* Be as specific as possible providing a precise explanation of feature request so anyone can understand the problem and the benefits of solving it. |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2016 Xmartlabs SRL | ||
|
||
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. |
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
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 |
---|---|---|
@@ -0,0 +1,14 @@ | ||
Pod::Spec.new do |s| | ||
s.name = "SuggestionRow" | ||
s.version = "1.0.0" | ||
s.summary = "Eureka row that displays completion suggestions either below the row in a table view or in the input accessory view above the keyboard." | ||
s.homepage = "https://github.com/EurekaCommunity/SuggestionRow" | ||
s.license = { type: 'MIT', file: 'LICENSE' } | ||
s.author = { "Xmartlabs SRL" => "[email protected]" } | ||
s.source = { git: "https://github.com/EurekaCommunity/SuggestionRow.git", tag: s.version.to_s } | ||
s.social_media_url = 'https://twitter.com/EurekaCommunity' | ||
s.ios.deployment_target = '8.0' | ||
s.requires_arc = true | ||
s.ios.source_files = 'Sources/**/*.{swift}' | ||
s.dependency 'Eureka', '3.0' | ||
end |
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