Skip to content

Commit

Permalink
Update documentation and other files (#68)
Browse files Browse the repository at this point in the history
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
47erbot and github-actions[bot] committed Apr 24, 2020
1 parent 023fcbd commit 76acdd6
Show file tree
Hide file tree
Showing 34 changed files with 465 additions and 60 deletions.
43 changes: 43 additions & 0 deletions AUTHORS.md
@@ -0,0 +1,43 @@
[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:

- [![47erbot](https://avatars1.githubusercontent.com/u/24799081?v=4&s=20) **47erbot**](https://github.com/47erbot)
- [![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)
- [![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)
- [![calvellido](https://avatars0.githubusercontent.com/u/7753447?v=4&s=20) **Juan Valencia (calvellido)**](https://github.com/calvellido)
- [![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-shapeless_ project:

- [![juanpedromoreno](https://avatars2.githubusercontent.com/u/4879373?v=4&s=20) **juanpedromoreno**](https://github.com/juanpedromoreno)
- [![rafaparadela](https://avatars3.githubusercontent.com/u/315070?v=4&s=20) **rafaparadela**](https://github.com/rafaparadela)
- [![dominv](https://avatars1.githubusercontent.com/u/3943031?v=4&s=20) **dominv**](https://github.com/dominv)
- [![kiroco12](https://avatars1.githubusercontent.com/u/48894338?v=4&s=20) **kiroco12**](https://github.com/kiroco12)
- [![jdesiloniz](https://avatars2.githubusercontent.com/u/2835739?v=4&s=20) **jdesiloniz**](https://github.com/jdesiloniz)
- [![oranda](https://avatars2.githubusercontent.com/u/1654472?v=4&s=20) **oranda**](https://github.com/oranda)
- [![calvellido](https://avatars0.githubusercontent.com/u/7753447?v=4&s=20) **calvellido**](https://github.com/calvellido)
- [![angoglez](https://avatars0.githubusercontent.com/u/10107285?v=4&s=20) **angoglez**](https://github.com/angoglez)
- [![raulraja](https://avatars3.githubusercontent.com/u/456796?v=4&s=20) **raulraja**](https://github.com/raulraja)
- [![47erbot](https://avatars1.githubusercontent.com/u/24799081?v=4&s=20) **47erbot**](https://github.com/47erbot)
- [![andyscott](https://avatars3.githubusercontent.com/u/310363?v=4&s=20) **andyscott**](https://github.com/andyscott)
- [![durban](https://avatars2.githubusercontent.com/u/1568978?v=4&s=20) **durban**](https://github.com/durban)
- [![fchaillou](https://avatars2.githubusercontent.com/u/515348?v=4&s=20) **fchaillou**](https://github.com/fchaillou)
- [![aborg0](https://avatars2.githubusercontent.com/u/153506?v=4&s=20) **aborg0**](https://github.com/aborg0)
- [![Narigo](https://avatars3.githubusercontent.com/u/1767865?v=4&s=20) **Narigo**](https://github.com/Narigo)
- [![logistark](https://avatars3.githubusercontent.com/u/1732430?v=4&s=20) **logistark**](https://github.com/logistark)
- [![matthedude](https://avatars2.githubusercontent.com/u/1004871?v=4&s=20) **matthedude**](https://github.com/matthedude)
- [![NickShadder](https://avatars0.githubusercontent.com/u/13987062?v=4&s=20) **NickShadder**](https://github.com/NickShadder)
22 changes: 22 additions & 0 deletions 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).
31 changes: 31 additions & 0 deletions 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-shapeless_ happens in the [GitHub issues](https://github.com/scala-exercises/exercises-shapeless/issues) and [pull requests](https://github.com/scala-exercises/exercises-shapeless/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-shapeless_ 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-shapeless_ 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.
9 changes: 9 additions & 0 deletions 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-shapeless

Copyright (c) 2016-2020 47 Degrees. All rights reserved.

Licensed under Apache-2.0. See [LICENSE](LICENSE.md) for terms.
14 changes: 12 additions & 2 deletions src/main/scala/shapeless/ArityExercises.scala
@@ -1,7 +1,17 @@
/*
* scala-exercises - exercises-shapeless
* Copyright (C) 2015-2019 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 shapelessex
Expand Down
14 changes: 12 additions & 2 deletions src/main/scala/shapeless/AutoTypeClassExercises.scala
@@ -1,7 +1,17 @@
/*
* scala-exercises - exercises-shapeless
* Copyright (C) 2015-2019 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 shapelessex
Expand Down
14 changes: 12 additions & 2 deletions src/main/scala/shapeless/CoproductExercises.scala
@@ -1,7 +1,17 @@
/*
* scala-exercises - exercises-shapeless
* Copyright (C) 2015-2019 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 shapelessex
Expand Down
14 changes: 12 additions & 2 deletions src/main/scala/shapeless/ExtensibleRecordsExercises.scala
@@ -1,7 +1,17 @@
/*
* scala-exercises - exercises-shapeless
* Copyright (C) 2015-2019 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 shapelessex
Expand Down
14 changes: 12 additions & 2 deletions src/main/scala/shapeless/GenericExercises.scala
@@ -1,7 +1,17 @@
/*
* scala-exercises - exercises-shapeless
* Copyright (C) 2015-2019 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 shapelessex
Expand Down
14 changes: 12 additions & 2 deletions src/main/scala/shapeless/HListExercises.scala
@@ -1,7 +1,17 @@
/*
* scala-exercises - exercises-shapeless
* Copyright (C) 2015-2019 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 shapelessex
Expand Down
14 changes: 12 additions & 2 deletions src/main/scala/shapeless/HMapExercises.scala
@@ -1,7 +1,17 @@
/*
* scala-exercises - exercises-shapeless
* Copyright (C) 2015-2019 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 shapelessex
Expand Down
14 changes: 12 additions & 2 deletions src/main/scala/shapeless/LazyExercises.scala
@@ -1,7 +1,17 @@
/*
* scala-exercises - exercises-shapeless
* Copyright (C) 2015-2019 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 shapelessex
Expand Down
14 changes: 12 additions & 2 deletions src/main/scala/shapeless/LensesExercises.scala
@@ -1,7 +1,17 @@
/*
* scala-exercises - exercises-shapeless
* Copyright (C) 2015-2019 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 shapelessex
Expand Down
14 changes: 12 additions & 2 deletions src/main/scala/shapeless/PolyExercises.scala
@@ -1,7 +1,17 @@
/*
* scala-exercises - exercises-shapeless
* Copyright (C) 2015-2019 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 shapelessex
Expand Down
14 changes: 12 additions & 2 deletions src/main/scala/shapeless/ShapelessLib.scala
@@ -1,7 +1,17 @@
/*
* scala-exercises - exercises-shapeless
* Copyright (C) 2015-2019 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 shapelessex
Expand Down
14 changes: 12 additions & 2 deletions src/main/scala/shapeless/SingletonExercises.scala
@@ -1,7 +1,17 @@
/*
* scala-exercises - exercises-shapeless
* Copyright (C) 2015-2019 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 shapelessex
Expand Down
14 changes: 12 additions & 2 deletions src/main/scala/shapeless/SizedExercises.scala
@@ -1,7 +1,17 @@
/*
* scala-exercises - exercises-shapeless
* Copyright (C) 2015-2019 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 shapelessex
Expand Down
14 changes: 12 additions & 2 deletions src/main/scala/shapeless/TuplesHListExercises.scala
@@ -1,7 +1,17 @@
/*
* scala-exercises - exercises-shapeless
* Copyright (C) 2015-2019 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 shapelessex
Expand Down

0 comments on commit 76acdd6

Please sign in to comment.