Skip to content

Commit 1c019ba

Browse files
Adding contribution guidelines
1 parent 8e7305c commit 1c019ba

File tree

7 files changed

+98
-8
lines changed

7 files changed

+98
-8
lines changed

.github/CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing Guidelines
2+
3+
- If you have an idea/suggestion, bug report or anything you think might be of interest - don't be shy,
4+
[create a ticket](https://github.com/kevalpatel2106/FingerprintDialogCompat/issues/new). No idea is bad, no opinion is wrong.
5+
- If you see a typo, misbehaving rule or something simply out of place - send a PR. I try to merge fixes within 24h.
6+
7+
## Simple 3 step to contribute into this repo:
8+
1. Fork the project.
9+
2. Make required changes and commit.
10+
3. Generate pull request. Mention all the required description regarding changes you made. If the PR is based on any bug report already filed, make sure to mention that issue in your PR description.
11+
12+
##FAQ:
13+
## How to setup the project?
14+
- Clone the repo to your local machine.
15+
```
16+
git clone https://github.com/kevalpatel2106/FingerprintDialogCompat.git
17+
```
18+
19+
Happy coding.:-)
20+
21+
<div align="center">
22+
<img src="https://cloud.githubusercontent.com/assets/370176/26526332/03bb8ac2-432c-11e7-89aa-da3cd1c0e9cb.png">
23+
</div>

.github/IMPORT.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Dependencies
2+
3+
- You can find the latest version from [here](https://github.com/kevalpatel2106/android-ruler-picker/releases).
4+
5+
---------------------------------------------
6+
### Gradle:
7+
- Add below dependency into your build.gradle file.
8+
9+
```groovy
10+
implementation 'com.kevalpatel2106:fingerprint-dialog-compat:[latest version]'
11+
```
12+
13+
### Maven:
14+
```
15+
<dependency>
16+
<groupId>com.kevalpatel2106</groupId>
17+
<artifactId>fingerprint-dialog-compat</artifactId>
18+
<version>[latest version]</version>
19+
<type>pom</type>
20+
</dependency>
21+
```
22+
23+
### AAR file:
24+
- You can download the latest version of the AAR file in integrate that into your project from [here](https://github.com/kevalpatel2106/fingerprint-dialog-compat/releases).

.github/ISSUE_GUIDE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# How to file new issue/Feature request?
2+
3+
- Please provide as much as detail and example as you can.
4+
- Add screenshots if appropriate.
5+
- Make sure the included [ISSUE_TEMPLATE](.github/ISSUE_TEMPLATE.md) is filled.
6+
- If you planning to report multiple FRs/Issues that falls under the same category ~PLEASE REPORT THEM IN ONE TICKET~.
7+
- Make sure that you are always on the latest version.
8+
- Search issue before submitting a new one. Make sure the issue doesn't exists, lets keep things clean & tidy here :).
9+
10+
Happy coding.:-)
11+
12+
<div align="center">
13+
<img src="https://cloud.githubusercontent.com/assets/370176/26526332/03bb8ac2-432c-11e7-89aa-da3cd1c0e9cb.png">
14+
</div>

.github/ISSUE_TEMPLATE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
** Describe your issue/feature request here Make sure you read [ISSUE_GUIDE](/.github/ISSUE_GUIDE.md). **
2+
-------------------------------------
3+
4+
**Library Version:** <!-- e.g. Version 1.23 -->
5+
6+
**Android Version:** <!-- Android 8.1 -->
7+
8+
**Device Information:**
9+
- MANUFACTURER: <!-- e.g. Samsung Electornics Limited -->
10+
- BRAND: <!-- e.g. Galaxy S4 -->
11+
- MODEL: <!-- e.g. GT-I9500 -->
12+
-------------------------------------

.idea/copyright/Apche_2_0.xml

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/copyright/profiles_settings.xml

Lines changed: 1 addition & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,24 @@
11
# FingerprintDialogCompat
2-
FingerprintDialog fron Android 28 (P) back ported to Android 23 (M).
2+
3+
[![Build Status](https://travis-ci.org/kevalpatel2106/FingerprintDialogCompat.svg?branch=master)](https://travis-ci.org/kevalpatel2106/FingerprintDialogCompat) [![API](https://img.shields.io/badge/API-14%2B-orange.svg?style=flat)](https://android-arsenal.com/api?level=14) <a href="https://www.paypal.me/kevalpatel2106"> <img src="https://img.shields.io/badge/paypal-donate-yellow.svg" /></a> [![Javadoc](https://img.shields.io/badge/JavaDoc-master-brightgreen.svg?style=orange)](http://kevalpatel2106.com/FingerprintDialogCompat/)
4+
5+
#### FingerprintDialog from Android 28 (P) back ported to Android 23 (M).
6+
7+
## Want to contribute?
8+
Every small or large contribution to this project is appreciated. Make sure you read the [contribution guide](/.github/CONTRIBUTING.md) before generating the pull request.
9+
10+
## Questions?🤔
11+
Hit me on twitter [![Twitter](https://img.shields.io/badge/Twitter-@kevalpatel2106-blue.svg?style=flat)](https://twitter.com/kevalpatel2106)
12+
13+
## License
14+
Copyright 2018 Keval Patel
15+
16+
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
17+
18+
http://www.apache.org/licenses/LICENSE-2.0
19+
20+
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
21+
22+
<div align="center">
23+
<img src="https://cloud.githubusercontent.com/assets/370176/26526332/03bb8ac2-432c-11e7-89aa-da3cd1c0e9cb.png">
24+
</div>

0 commit comments

Comments
 (0)