Skip to content

Commit cc85a27

Browse files
docs: add Contributing and Getting started
1 parent 29689f4 commit cc85a27

2 files changed

Lines changed: 22 additions & 11 deletions

File tree

Binary file not shown.

README.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,12 @@ Emoji picker for iOS like on macOS
1919
- [Selected emoji category tint color](#selected-emoji-category-tint-color)
2020
- [Arrow direction](#arrow-direction)
2121
- [Horizontal inset](#horizontal-inset)
22-
- [Is dismiss after choosing](#is-dismiss-after-choosing)
22+
- [Is dismissed after choosing](#is-dismissed-after-choosing)
2323
- [Custom height](#custom-height)
2424
- [Feedback generator style](#feedback-generator-style)
2525
- [Localizations](#localizations)
26-
- [Experiments](#experiments)
26+
- [Contributing](#contributing)
27+
- [Getting started](#getting-started)
2728

2829
## Installation
2930

@@ -33,7 +34,7 @@ Ready for use with Swift 4.2+ on iOS 11.1+
3334

3435
The [Swift Package Manager](https://www.swift.org/package-manager/) is a tool for automating the distribution of Swift code and is integrated into the `swift` compiler. It’s integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.
3536

36-
In Xcode navigate to File → Swift Packages → Add Package Dependency. Use this URL to add the dependency:
37+
In Xcode navigate to File → Swift Packages → Add Package Dependency. Use this URL to add the dependency:
3738

3839
```
3940
‌https://github.com/htmlprogrammist/EmojiPicker
@@ -126,7 +127,7 @@ Inset from the `sourceView` border. The default value of this property is `0`.
126127
viewController.horizontalInset = 0
127128
```
128129

129-
### Is dismiss after choosing
130+
### Is dismissed after choosing
130131

131132
Defines whether to dismiss emoji picker or not after choosing. The default value of this property is `true`.
132133

@@ -160,13 +161,23 @@ viewController.feedbackGeneratorStyle = .soft
160161
* Hindi 🇮🇳
161162
* Turkish 🇹🇷
162163

163-
## Experiments
164+
You can also contribute your language to this list. Please, read [following heading](#contributing) for more information.
164165

165-
You can also play around with the project, see how it works or adapt it for yourself and immediately see the result:
166+
## Contributing
167+
168+
Contributions are welcomed and encouraged! Please see the [Contributing guide](https://github.com/htmlprogrammist/EmojiPicker/blob/main/CONTRIBUTING.md).
169+
170+
To be a truly great community, we need to welcome developers from all walks of life, with different backgrounds, and with a wide range of experience. A diverse and friendly community will have more great ideas, more unique perspectives, and produce more great code. We will work diligently to make our community welcoming to everyone.
171+
172+
To give clarity of what is expected of our members, we have adopted the code of conduct defined by the Contributor Covenant. This document is used across many open source communities, and we think it articulates our values well. For more, see the [Code of Conduct](https://github.com/htmlprogrammist/EmojiPicker/blob/main/CODE_OF_CONDUCT.md).
173+
174+
## Getting started
175+
176+
To play around with the project, contribute to it, see how it works or adapt it for yourself:
166177

167178
1. Clone or fork this repository to yourself
168-
1. Open `EmojiPicker.xcworkspace` file
169-
2. Expand `Pods` target
170-
3. Expand `Development Pods` and `EmojiPicker` directory (here you can make changes)
171-
4. Make sure you have set `EmojiPicker-Example` as target for a run
172-
5. Have fun! Build & run the project
179+
2. Open `Example App/EmojiPicker.xcworkspace` file
180+
3. Expand `Pods` target
181+
4. Expand `Development Pods` and `EmojiPicker` directories
182+
Here you can make your changes.
183+
5. Build & Run project to see an immediate result on an example application. Have fun!

0 commit comments

Comments
 (0)