Update documentation and other files (#93)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
scala-exercises · Apr 24, 2020 · 0ba88b2 · 0ba88b2
1 parent 3437c3a
commit 0ba88b2
Show file tree

Hide file tree

Showing 36 changed files with 484 additions and 63 deletions.
diff --git a/AUTHORS.md b/AUTHORS.md
@@ -0,0 +1,49 @@
+[comment]: <> (Don't edit this file!)
+[comment]: <> (It is automatically updated after every release of https://github.com/47degrees/.github)
+[comment]: <> (If you want to suggest a change, please open a PR or issue in that repository)
+
+# Authors
+
+## Maintainers
+
+The maintainers of the project are:
+
+- [![angoglez](https://avatars0.githubusercontent.com/u/10107285?v=4&s=20) **Ana Gómez González (angoglez)**](https://github.com/angoglez)
+- [![andyscott](https://avatars3.githubusercontent.com/u/310363?v=4&s=20) **Andy Scott (andyscott)**](https://github.com/andyscott)
+- [![dominv](https://avatars1.githubusercontent.com/u/3943031?v=4&s=20) **Domingo Valera (dominv)**](https://github.com/dominv)
+- [![kiroco12](https://avatars1.githubusercontent.com/u/48894338?v=4&s=20) **Enrique Nieto (kiroco12)**](https://github.com/kiroco12)
+- [![FRosner](https://avatars2.githubusercontent.com/u/3427394?v=4&s=20) **Frank Rosner (FRosner)**](https://github.com/FRosner)
+- [![jdesiloniz](https://avatars2.githubusercontent.com/u/2835739?v=4&s=20) **Javier de Silóniz Sandino (jdesiloniz)**](https://github.com/jdesiloniz)
+- [![juanpedromoreno](https://avatars2.githubusercontent.com/u/4879373?v=4&s=20) **Juan Pedro Moreno (juanpedromoreno)**](https://github.com/juanpedromoreno)
+- [![rafaparadela](https://avatars3.githubusercontent.com/u/315070?v=4&s=20) **Rafa Paradela (rafaparadela)**](https://github.com/rafaparadela)
+- [![raulraja](https://avatars3.githubusercontent.com/u/456796?v=4&s=20) **Raúl Raja Martínez (raulraja)**](https://github.com/raulraja)
+
+## Contributors
+
+These are the people that have contributed to the _exercises-cats_ project:
+
+- [![juanpedromoreno](https://avatars2.githubusercontent.com/u/4879373?v=4&s=20) **juanpedromoreno**](https://github.com/juanpedromoreno)
+- [![raulraja](https://avatars3.githubusercontent.com/u/456796?v=4&s=20) **raulraja**](https://github.com/raulraja)
+- [![kiroco12](https://avatars1.githubusercontent.com/u/48894338?v=4&s=20) **kiroco12**](https://github.com/kiroco12)
+- [![rafaparadela](https://avatars3.githubusercontent.com/u/315070?v=4&s=20) **rafaparadela**](https://github.com/rafaparadela)
+- [![aeons](https://avatars2.githubusercontent.com/u/1432894?v=4&s=20) **aeons**](https://github.com/aeons)
+- [![dominv](https://avatars1.githubusercontent.com/u/3943031?v=4&s=20) **dominv**](https://github.com/dominv)
+- [![jdesiloniz](https://avatars2.githubusercontent.com/u/2835739?v=4&s=20) **jdesiloniz**](https://github.com/jdesiloniz)
+- [![doub1ejack](https://avatars2.githubusercontent.com/u/1809882?v=4&s=20) **doub1ejack**](https://github.com/doub1ejack)
+- [![yilinwei](https://avatars0.githubusercontent.com/u/8933128?v=4&s=20) **yilinwei**](https://github.com/yilinwei)
+- [![angoglez](https://avatars0.githubusercontent.com/u/10107285?v=4&s=20) **angoglez**](https://github.com/angoglez)
+- [![andyscott](https://avatars3.githubusercontent.com/u/310363?v=4&s=20) **andyscott**](https://github.com/andyscott)
+- [![ches](https://avatars3.githubusercontent.com/u/13277?v=4&s=20) **ches**](https://github.com/ches)
+- [![FRosner](https://avatars2.githubusercontent.com/u/3427394?v=4&s=20) **FRosner**](https://github.com/FRosner)
+- [![ikhoon](https://avatars1.githubusercontent.com/u/1866157?v=4&s=20) **ikhoon**](https://github.com/ikhoon)
+- [![jkmcclellan](https://avatars3.githubusercontent.com/u/52432856?v=4&s=20) **jkmcclellan**](https://github.com/jkmcclellan)
+- [![mayonesa](https://avatars3.githubusercontent.com/u/56529?v=4&s=20) **mayonesa**](https://github.com/mayonesa)
+- [![lloydmeta](https://avatars3.githubusercontent.com/u/914805?v=4&s=20) **lloydmeta**](https://github.com/lloydmeta)
+- [![mttkay](https://avatars3.githubusercontent.com/u/102802?v=4&s=20) **mttkay**](https://github.com/mttkay)
+- [![paualarco](https://avatars0.githubusercontent.com/u/33580722?v=4&s=20) **paualarco**](https://github.com/paualarco)
+- [![richardmiller](https://avatars1.githubusercontent.com/u/783827?v=4&s=20) **richardmiller**](https://github.com/richardmiller)
+- [![sergiohgz](https://avatars3.githubusercontent.com/u/14012309?v=4&s=20) **sergiohgz**](https://github.com/sergiohgz)
+- [![Thangiee](https://avatars2.githubusercontent.com/u/4734933?v=4&s=20) **Thangiee**](https://github.com/Thangiee)
+- [![TobiasRoland](https://avatars2.githubusercontent.com/u/5878818?v=4&s=20) **TobiasRoland**](https://github.com/TobiasRoland)
+- [![Kobenko](https://avatars0.githubusercontent.com/u/21039161?v=4&s=20) **Kobenko**](https://github.com/Kobenko)
+- [![RawToast](https://avatars2.githubusercontent.com/u/8013000?v=4&s=20) **RawToast**](https://github.com/RawToast)
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,22 @@
+[comment]: <> (Don't edit this file!)
+[comment]: <> (It is automatically updated after every release of https://github.com/47degrees/.github)
+[comment]: <> (If you want to suggest a change, please open a PR or issue in that repository)
+
+# Code of Conduct
+
+We are committed to providing a friendly, safe and welcoming
+environment for all, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal
+appearance, body size, race, ethnicity, age, religion, nationality, or
+other such characteristics.
+
+Everyone is expected to follow the
+[Scala Code of Conduct](https://typelevel.org/code-of-conduct.html) when
+discussing the project on the available communication channels. If you
+are being harassed, please contact us immediately so that we can
+support you.
+
+## Moderation
+
+For any questions, concerns, or moderation requests please contact a
+[member of the project](AUTHORS.md#maintainers).
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,31 @@
+[comment]: <> (Don't edit this file!)
+[comment]: <> (It is automatically updated after every release of https://github.com/47degrees/.github)
+[comment]: <> (If you want to suggest a change, please open a PR or issue in that repository)
+
+# Contributing
+
+Discussion around _exercises-cats_ happens in the [GitHub issues](https://github.com/scala-exercises/exercises-cats/issues) and [pull requests](https://github.com/scala-exercises/exercises-cats/pulls).
+
+Feel free to open an issue if you notice a bug, have an idea for a feature, or have a question about
+the code. Pull requests are also welcome.
+
+People are expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md) when discussing _exercises-cats_ on the Github page or other venues.
+
+If you are being harassed, please contact one of [us](AUTHORS.md#maintainers) immediately so that we can support you. In case you cannot get in touch with us please write an email to [47 Degrees](mailto:scala-exercises@47deg.com).
+
+## How can I help?
+
+_exercises-cats_ follows a standard [fork and pull](https://help.github.com/articles/using-pull-requests/) model for contributions via GitHub pull requests.
+
+The process is simple:
+
+ 1. Find something you want to work on
+ 2. Let us know you are working on it via GitHub issues/pull requests
+ 3. Implement your contribution
+ 4. Write tests
+ 5. Update the documentation
+ 6. Submit pull request
+
+You will be automatically included in the [AUTHORS.md](AUTHORS.md#contributors) file as contributor in the next release.
+
+If you encounter any confusion or frustration during the contribution process, please create a GitHub issue and we'll do our best to improve the process.
diff --git a/LICENSE.md b/LICENSE.md
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright (C)  @YEAR_RANGE@ @COPYRIGHT_OWNER@
+   Copyright (C)  2016-2020 47 Degrees <https://47deg.com>
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/NOTICE.md b/NOTICE.md
@@ -0,0 +1,9 @@
+[comment]: <> (Don't edit this file!)
+[comment]: <> (It is automatically updated after every release of https://github.com/47degrees/.github)
+[comment]: <> (If you want to suggest a change, please open a PR or issue in that repository)
+
+exercises-cats
+
+Copyright (c) 2016-2020 47 Degrees. All rights reserved.
+
+Licensed under Apache-2.0. See [LICENSE](LICENSE.md) for terms.
diff --git a/src/main/scala/catslib/Applicative.scala b/src/main/scala/catslib/Applicative.scala
@@ -1,7 +1,17 @@
 /*
- *  scala-exercises - exercises-cats
- *  Copyright (C) 2015-2020 47 Degrees, LLC. <http://www.47deg.com>
+ * Copyright 2016-2020 47 Degrees <https://47deg.com>
  *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
  */
 
 package catslib

diff --git a/src/main/scala/catslib/Apply.scala b/src/main/scala/catslib/Apply.scala
@@ -1,7 +1,17 @@
 /*
- *  scala-exercises - exercises-cats
- *  Copyright (C) 2015-2020 47 Degrees, LLC. <http://www.47deg.com>
+ * Copyright 2016-2020 47 Degrees <https://47deg.com>
  *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
  */
 
 package catslib

diff --git a/src/main/scala/catslib/ApplyHelpers.scala b/src/main/scala/catslib/ApplyHelpers.scala
@@ -1,7 +1,17 @@
 /*
- *  scala-exercises - exercises-cats
- *  Copyright (C) 2015-2020 47 Degrees, LLC. <http://www.47deg.com>
+ * Copyright 2016-2020 47 Degrees <https://47deg.com>
  *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
  */
 
 package catslib

diff --git a/src/main/scala/catslib/CatsLibrary.scala b/src/main/scala/catslib/CatsLibrary.scala
@@ -1,7 +1,17 @@
 /*
- *  scala-exercises - exercises-cats
- *  Copyright (C) 2015-2020 47 Degrees, LLC. <http://www.47deg.com>
+ * Copyright 2016-2020 47 Degrees <https://47deg.com>
  *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
  */
 
 package catslib

diff --git a/src/main/scala/catslib/EitherSection.scala b/src/main/scala/catslib/EitherSection.scala
@@ -1,7 +1,17 @@
 /*
- *  scala-exercises - exercises-cats
- *  Copyright (C) 2015-2020 47 Degrees, LLC. <http://www.47deg.com>
+ * Copyright 2016-2020 47 Degrees <https://47deg.com>
  *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
  */
 
 package catslib

diff --git a/src/main/scala/catslib/EvalSection.scala b/src/main/scala/catslib/EvalSection.scala
@@ -1,7 +1,17 @@
 /*
- *  scala-exercises - exercises-cats
- *  Copyright (C) 2015-2020 47 Degrees, LLC. <http://www.47deg.com>
+ * Copyright 2016-2020 47 Degrees <https://47deg.com>
  *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
  */
 
 package catslib

diff --git a/src/main/scala/catslib/Foldable.scala b/src/main/scala/catslib/Foldable.scala
@@ -1,7 +1,17 @@
 /*
- *  scala-exercises - exercises-cats
- *  Copyright (C) 2015-2020 47 Degrees, LLC. <http://www.47deg.com>
+ * Copyright 2016-2020 47 Degrees <https://47deg.com>
  *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
  */
 
 package catslib

diff --git a/src/main/scala/catslib/FunctorSection.scala b/src/main/scala/catslib/FunctorSection.scala
@@ -1,7 +1,17 @@
 /*
- *  scala-exercises - exercises-cats
- *  Copyright (C) 2015-2020 47 Degrees, LLC. <http://www.47deg.com>
+ * Copyright 2016-2020 47 Degrees <https://47deg.com>
  *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
  */
 
 package catslib

diff --git a/src/main/scala/catslib/IdentitySection.scala b/src/main/scala/catslib/IdentitySection.scala
@@ -1,7 +1,17 @@
 /*
- *  scala-exercises - exercises-cats
- *  Copyright (C) 2015-2020 47 Degrees, LLC. <http://www.47deg.com>
+ * Copyright 2016-2020 47 Degrees <https://47deg.com>
  *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
  */
 
 package catslib

diff --git a/src/main/scala/catslib/Monad.scala b/src/main/scala/catslib/Monad.scala
@@ -1,7 +1,17 @@
 /*
- *  scala-exercises - exercises-cats
- *  Copyright (C) 2015-2020 47 Degrees, LLC. <http://www.47deg.com>
+ * Copyright 2016-2020 47 Degrees <https://47deg.com>
  *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
  */
 
 package catslib

diff --git a/src/main/scala/catslib/MonadHelpers.scala b/src/main/scala/catslib/MonadHelpers.scala
@@ -1,7 +1,17 @@
 /*
- *  scala-exercises - exercises-cats
- *  Copyright (C) 2015-2020 47 Degrees, LLC. <http://www.47deg.com>
+ * Copyright 2016-2020 47 Degrees <https://47deg.com>
  *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
  */
 
 package catslib

diff --git a/src/main/scala/catslib/Monoid.scala b/src/main/scala/catslib/Monoid.scala
@@ -1,7 +1,17 @@
 /*
- *  scala-exercises - exercises-cats
- *  Copyright (C) 2015-2020 47 Degrees, LLC. <http://www.47deg.com>
+ * Copyright 2016-2020 47 Degrees <https://47deg.com>
  *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
  */
 
 package catslib

diff --git a/src/main/scala/catslib/OptionTSection.scala b/src/main/scala/catslib/OptionTSection.scala
@@ -1,7 +1,17 @@
 /*
- *  scala-exercises - exercises-cats
- *  Copyright (C) 2015-2020 47 Degrees, LLC. <http://www.47deg.com>
+ * Copyright 2016-2020 47 Degrees <https://47deg.com>
  *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
  */
 
 package catslib