Merge pull request evrencoskun#359 from MGaetan89/update_license

Update license and add a basic contribution guide

Author: evrencoskun

.github/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Contributing to `TableView`
+
+## Table of contents
+
+- [I need help/I have a question](#i-need-helpi-have-a-question)
+- [Reporting a bug](#reporting-a-bug)
+- [Suggest a new feature](#suggest-a-new-feature)
+- [Contributing to the project](#contributing-to-the-project)
+
+## I need help/I have a question
+
+If you need help to integrate this library in your project, or if you have a generic question about it, please use [Stack Overflow](https://stackoverflow.com/questions/tagged/tableview+android), with the `TableView` and `Android` tags.
+
+## Reporting a bug
+
+If the library is not behaving as you would expect, please [open a new issue](https://github.com/evrencoskun/TableView/issues/new), after checking that it hasn't been reported yet.
+Don't forget to provide as much information as you can:
+
+- What are you trying to do?
+- What happened instead?
+- In case of crash, include the stacktace.
+- Which version of the library are you using?
+- Which version of Android is this issue happening on?
+
+## Suggest a new feature
+
+If you would like a new feature to be added to the library, please [open a new issue](https://github.com/evrencoskun/TableView/issues/new) to describe it.
+
+## Contributing to the project
+
+Every contribution is welcome to the library. Simply [open a new Pull Request](https://github.com/evrencoskun/TableView/compare) with your changes, so they can be reviewed and merged into the project, and eventually released to everyone.
+
+Note that by making a contribution to this project you are agreeing to have your contributions governed by the [MIT License](https://github.com/evrencoskun/TableView/blob/master/LICENSE) copyright statement.
+This means that to the extent possible under law, you transfer all copyright and related or neighbouring rights of the code or documents you contribute to the project itself. You also represent that you have the authority to perform the above waiver with respect to the entirety of you contributions.

CONTRIBUTORS.md

@@ -1,6 +1,6 @@
 <div align="center">
     <img src="https://raw.githubusercontent.com/evrencoskun/TableViewSample/master/art/Logo-5.png" >
-    <h2>TableView For Android</h2>
+    <h2>TableView for Android</h2>
     <p align="center">
         <p>TableView is a powerful Android library for displaying complex data structures and rendering tabular data composed of rows, columns and cells. 
            TableView relies on a separate model object to hold and represent the data it displays. This repository also contains a sample app that is
@@ -20,30 +20,30 @@
 
 ## Features
 
-  - [x] Each column width value can be calculated automatically considering the largest one
-  - [x] Setting your own model class to displayed in a table view easily.
-  - [x] TableView has an action listener interface to listen user touch interaction for each cell.
-  - [x] TableView columns can be sorted in ascending or descending order.
-  - [x] Hiding & Showing the row and the column is pretty easy. 
+  - [x] Each column width value can be calculated automatically considering the largest one.
+  - [x] Setting your own model class to be displayed in a table view easily.
+  - [x] `TableView` has an action listener interface to listen user touch interaction for each cell.
+  - [x] `TableView` columns can be sorted in ascending or descending order.
+  - [x] Hiding & showing the rows and columns is pretty easy.
   - [x] Filtering by more than one data.
   - [x] Pagination functionality.
-    
+
 ## What's new
 
-You can check new implementations of TableView on the [release page](https://github.com/evrencoskun/TableView/releases). 
+You can check new implementations of `TableView` on the [release page](https://github.com/evrencoskun/TableView/releases).
 
 ## Table of Contents
+
   - [Installation](#installation)
   - [Documentation](#documentation)
   - [Sample Apps](#sample-apps)
   - [Donations](#donations)
-  - [Communication](#communication)
   - [Contributors](#contributors)
   - [License](#license)
 
 ## Installation
 
-To use this library in your android project, just simply add the following dependency into your build.gradle
+To use this library in your Android project, just add the following dependency into your module's `build.gradle`:
 
 ```
 dependencies {
@@ -53,26 +53,14 @@ dependencies {
 
 ## Documentation 
 
-Please check out [wiki page](https://github.com/evrencoskun/TableView/wiki).
-
+Please check out the [project's wiki](https://github.com/evrencoskun/TableView/wiki).
 
 ## Sample Apps
 
-- This repository has an Sample Application of TableView.
+- This repository has a [sample application](https://github.com/evrencoskun/TableView/tree/master/app) of `TableView`.
 - [TableViewSample 2](https://github.com/evrencoskun/TableViewSample2)
 - [Xently-UI](https://github.com/ajharry69/Xently-UI)
-- (contact me to mention your app on this page)
-
-
-## Communication
-
-- If you **need help**, please use [Stack Overflow](https://stackoverflow.com/questions/tagged/tableview+android). (Tag 'TableView' and 'Android')
-- If you'd like to **ask a general question**, please use [Stack Overflow](https://stackoverflow.com/questions/tagged/tableview+android).
-- If you **found a bug**, please open an issue.
-- If you **have a feature request**, please open an issue.
-- If you **want to contribute**, please submit a pull request.
-- If you **use the control**, please contact me to mention your app on this page.
-
+- ([Submit a Pull Request](https://github.com/evrencoskun/TableView/compare) to mention your app on this page)
 
 ## Donations
 
@@ -86,30 +74,35 @@ Please check out [wiki page](https://github.com/evrencoskun/TableView/wiki).
 - [**Donate 25 $**](https://www.paypal.me/evrencoshkun): That's some awesome stuff you did right there, dinner is on me!
 - Or you can also [**choose what you want to donate**](https://www.paypal.me/evrencoshkun), all donations are awesome!
 
-
 ## Contributors
 
-Contributions of any kind are welcome! I would like to thank the following [contributors](https://github.com/evrencoskun/TableView/blob/master/CONTRIBUTORS.md) for sharing code and 
-making TableView library a better product. 
+Contributions of any kind are welcome! I would like to thank all the [contributors](https://github.com/evrencoskun/TableView/graphs/contributors) for sharing code and
+making `TableView` a better product.
+
+If you wish to contribute to this project, please refer to our [contributing guide](.github/CONTRIBUTING.md).
 
 ## License
 
-    Copyright (c) 2017 Evren Coşkun
-    
-    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.
+```
+MIT License
+
+Copyright (c) 2021 Evren Coşkun
+
+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.
+```

README.md

@@ -1,18 +1,25 @@
 /*
- * Copyright (c) 2018. Evren Coşkun
+ * MIT License
  *
- *  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
+ * Copyright (c) 2021 Evren Coşkun
  *
- *        http://www.apache.org/licenses/LICENSE-2.0
+ * 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:
  *
- *  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.
+ * 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.
  */
 
 apply plugin: 'com.android.application'

app/build.gradle

@@ -1,4 +1,27 @@
 <?xml version="1.0" encoding="utf-8"?>
+<!--
+ ~ MIT License
+ ~
+ ~ Copyright (c) 2021 Evren Coşkun
+ ~
+ ~ 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.
+  -->
 <manifest package="com.evrencoskun.tableviewsample"
           xmlns:android="http://schemas.android.com/apk/res/android">
 

app/src/main/AndroidManifest.xml

@@ -1,18 +1,25 @@
 /*
- * Copyright (c) 2018. Evren Coşkun
+ * MIT License
  *
- *  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
+ * Copyright (c) 2021 Evren Coşkun
  *
- *        http://www.apache.org/licenses/LICENSE-2.0
+ * 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:
  *
- *  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.
+ * 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.
  */
 
 package com.evrencoskun.tableviewsample;

app/src/main/java/com/evrencoskun/tableviewsample/MainActivity.java

@@ -1,18 +1,25 @@
 /*
- * Copyright (c) 2018. Evren Coşkun
+ * MIT License
  *
- *  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
+ * Copyright (c) 2021 Evren Coşkun
  *
- *        http://www.apache.org/licenses/LICENSE-2.0
+ * 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:
  *
- *  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.
+ * 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.
  */
 
 package com.evrencoskun.tableviewsample;

app/src/main/java/com/evrencoskun/tableviewsample/MainFragment.java

@@ -1,18 +1,25 @@
 /*
- * Copyright (c) 2018. Evren Coşkun
+ * MIT License
  *
- *  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
+ * Copyright (c) 2021 Evren Coşkun
  *
- *        http://www.apache.org/licenses/LICENSE-2.0
+ * 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:
  *
- *  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.
+ * 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.
  */
 
 package com.evrencoskun.tableviewsample.tableview;
@@ -22,6 +29,9 @@
 import android.view.View;
 import android.view.ViewGroup;
 
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+
 import com.evrencoskun.tableview.adapter.AbstractTableAdapter;
 import com.evrencoskun.tableview.adapter.recyclerview.holder.AbstractViewHolder;
 import com.evrencoskun.tableview.sort.SortState;
@@ -35,9 +45,6 @@
 import com.evrencoskun.tableviewsample.tableview.model.ColumnHeader;
 import com.evrencoskun.tableviewsample.tableview.model.RowHeader;
 
-import androidx.annotation.NonNull;
-import androidx.annotation.Nullable;
-
 /**
  * Created by evrencoskun on 11/06/2017.
  * <p>