Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
ra1028 committed Jun 24, 2019
0 parents commit 3e216e1
Show file tree
Hide file tree
Showing 98 changed files with 12,591 additions and 0 deletions.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: Bug Report
about: Create a bug report.
---

## Checklist
- [ ] This is not a Apple's bug.
- [ ] Reviewed the README and documents.
- [ ] Searched existing issues for ensure not duplicated.

## Expected Behavior
<!--- Tell us what should happen -->

## Current Behavior
<!--- Tell us what happens instead of the expected behavior -->

## Steps to Reproduce
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this bug. Include code to reproduce, if relevant -->
1.
2.
3.
4.

## Detailed Description (Include Screenshots)
<!--- Provide a detailed description of the bug -->

## Reproducible Demo Project
<!--- If you have, provide links of bug reproducible project that we can refer -->

## Environments
- version:

- Swift version:

- iOS version:

- Xcode version:

- Devices/Simulators:

- CocoaPods/Carthage version:
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Feature Request
about: Create a feature request.
---

## Checklist
- [ ] Reviewed the README and documents.
- [ ] Searched existing issues for ensure not duplicated.

## Description
<!--- Provide a detailed description of the feature you are proposing -->

## Motivation and Context
<!--- Why is this feature required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->

## Proposed Solution
<!--- Describe the solution you proposing. -->
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/QUESTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Question
about: Create a bug question.
---

## Checklist
- [ ] Reviewed the README and documents.
- [ ] Searched existing issues for ensure not duplicated.

## Expected Behavior
<!--- Tell us what should happen -->

## Current Behavior
<!--- Tell us what happens instead of the expected behavior -->

## Detailed Description (Include Screenshots)
<!--- Provide a detailed description of your question -->

## Environment
- version:

- Swift version:

- iOS version:

- Xcode version:

- Devices/Simulators:

- CocoaPods/Carthage version:
23 changes: 23 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## Checklist
- [ ] All tests are passed.
- [ ] Added tests.
- [ ] Documented the code using [Xcode markup](https://developer.apple.com/library/mac/documentation/Xcode/Reference/xcode_markup_formatting_ref).
- [ ] Searched existing pull requests for ensure not duplicated.

## Description
<!--- Describe your changes in detail -->

## Related Issue
<!--- This project only accepts pull requests related to open issues -->
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
<!--- Please link to the issue here: -->

## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->

## Impact on Existing Code
<!--- Tell us the impact on existing code as far as you understand. -->

## Screenshots (if appropriate)
38 changes: 38 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
.DS_Store
*/build/*
*.pbxuser
!default.pbxuser
*.mode1v3
!default.mode1v3
*.mode2v3
!default.mode2v3
*.perspectivev3
!default.perspectivev3
xcuserdata
xcbaselines
profile
*.moved-aside
DerivedData
.idea/
*.hmap
*.xccheckout
*.xcuserstate
build/

## Documentation
docs/docsets/
docs/undocumented.json

## Gems
.bundle
vendor

## CocoaPods
Pods

## Carthage
Carthage/*
!Carthage/Checkouts

## Swift Package Manager
.build
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "Carthage/Checkouts/DifferenceKit"]
path = Carthage/Checkouts/DifferenceKit
url = https://github.com/ra1028/DifferenceKit.git
30 changes: 30 additions & 0 deletions .jazzy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# https://github.com/realm/jazzy

author: Ryo Aoyama
author_url: https://github.com/ra1028
github_url: https://github.com/ra1028/DiffableDataSources
module: DiffableDataSources
readme: README.md
output: docs
theme: fullwidth
clean: true
skip_undocumented: true
xcodebuild_arguments:
- -workspace
- DiffableDataSources.xcworkspace
- -scheme
- DiffableDataSources
- -sdk
- iphonesimulator

exclude:
- Sources/AppKit/CocoaCollectionViewDiffableDataSource.swift

custom_categories:
- name: DataSources
children:
- TableViewDiffableDataSource
- CollectionViewDiffableDataSource
- name: Snapshot
children:
- DiffableDataSourceSnapshot
1 change: 1 addition & 0 deletions .swift-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
5.0
34 changes: 34 additions & 0 deletions .swiftlint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# https://github.com/realm/SwiftLint

excluded:
- .build
- Carthage
- Examples

disabled_rules:
- type_name
- identifier_name
- generic_type_name
- force_cast

nesting:
type_level:
warning: 2

line_length:
warning: 200

file_length:
warning: 600

type_body_length:
warning: 400

function_body_length:
warning: 50

cyclomatic_complexity:
warning: 12

statement_position:
statement_mode: uncuddled_else
76 changes: 76 additions & 0 deletions 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 at [INSERT EMAIL ADDRESS]. 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
91 changes: 91 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# 🎈 Contributing

First of all, thanks for your interest.

There are several ways to contribute to this project. We welcome contributions in all ways.
We have made some contribution guidelines to smoothly incorporate your opinions and code into this project.

## 📝 Open Issue

When you found a bug or having a feature request, search for the issue from the existing issues and feel free to open the issue after making sure it isn't already reported.

In order to we understand your issue accurately, please include as much information as possible in the issue template.
The screenshot are also big clue to understand the issue.

If you know exactly how to fix the bug you report or implement the feature you propose, please pull request instead of an issue.

## 🚀 Pull Request

We are waiting for a pull request to make this project more better with us.
If you want to add a new feature, let's discuss about it first on issue.

### Lint

Please introduce [SwiftLint](https://github.com/realm/SwiftLint) into your environment before start writing the code.
Xcode automatically runs lint in the build phase.

The code written according to lint should match our coding style, but for particular cases where style is unknown, refer to the existing code base.

### Test

The test will tells us the validity of your code.
All codes entering the master must pass the all tests.
If you change the code or add new features, you should add tests.

### Documentation

Please write the document using [Xcode markup](https://developer.apple.com/library/archive/documentation/Xcode/Reference/xcode_markup_formatting_ref/) to the code you added.
Documentation template is inserted automatically by using Xcode shortcut **⌥⌘/**.
Our document style is slightly different from the template. The example is below.

```swift
/// The example class for documentation.
final class Foo {
/// A property value.
let prop: Int

/// Create a new foo with a param.
///
/// - Parameters:
/// - param: An Int value for prop.
init(param: Int) {
prop = param
}

/// Returns a string value concatenating `param1` and `param2`.
///
/// - Parameters:
/// - param1: An Int value for prefix.
/// - param2: A String value for suffix.
///
/// - Returns: A string concatenating given params.
func bar(param1: Int, param2: String) -> String {
return "\(param1)" + param2
}
}
```

## [Developer's Certificate of Origin 1.1](https://elinux.org/Developer_Certificate_Of_Origin)
By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or

(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or

(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.

(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
1 change: 1 addition & 0 deletions Cartfile
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github "ra1028/DifferenceKit" ~> 1.1
Loading

0 comments on commit 3e216e1

Please sign in to comment.