Skip to content

Commit a9c6c02

Browse files
Update documentation and other files (#457)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 58816e8 commit a9c6c02

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+340
-87
lines changed

AUTHORS.md

+42-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,51 @@
1+
[comment]: <> (Don't edit this file!)
2+
[comment]: <> (It is automatically updated after every release of https://github.com/47degrees/.github)
3+
[comment]: <> (If you want to suggest a change, please open a PR or issue in that repository)
4+
15
# Authors
26

37
## Maintainers
48

59
The maintainers of the project are:
610

7-
* 47 Degrees (twitter: @47deg) <[47degdev](https://github.com/47degdev)>
11+
- [![anamariamv](https://avatars0.githubusercontent.com/u/2183589?v=4&s=20) **Ana Mª Marquez (anamariamv)**](https://github.com/anamariamv)
12+
- [![BenFradet](https://avatars2.githubusercontent.com/u/1737211?v=4&s=20) **Ben Fradet (BenFradet)**](https://github.com/BenFradet)
13+
- [![fedefernandez](https://avatars0.githubusercontent.com/u/720923?v=4&s=20) **Fede Fernández (fedefernandez)**](https://github.com/fedefernandez)
14+
- [![jdesiloniz](https://avatars2.githubusercontent.com/u/2835739?v=4&s=20) **Javier de Silóniz Sandino (jdesiloniz)**](https://github.com/jdesiloniz)
15+
- [![juanpedromoreno](https://avatars2.githubusercontent.com/u/4879373?v=4&s=20) **Juan Pedro Moreno (juanpedromoreno)**](https://github.com/juanpedromoreno)
16+
- [![pepegar](https://avatars0.githubusercontent.com/u/694179?v=4&s=20) **Pepe García (pepegar)**](https://github.com/pepegar)
17+
- [![rafaparadela](https://avatars3.githubusercontent.com/u/315070?v=4&s=20) **Rafa Paradela (rafaparadela)**](https://github.com/rafaparadela)
818

919
## Contributors
1020

11-
These are the people that have contributed to the Github4s project:
21+
These are the people that have contributed to the _github4s_ project:
22+
23+
- [![BenFradet](https://avatars2.githubusercontent.com/u/1737211?v=4&s=20) **BenFradet**](https://github.com/BenFradet)
24+
- [![rafaparadela](https://avatars3.githubusercontent.com/u/315070?v=4&s=20) **rafaparadela**](https://github.com/rafaparadela)
25+
- [![47degdev](https://avatars3.githubusercontent.com/u/5580770?v=4&s=20) **47degdev**](https://github.com/47degdev)
26+
- [![juanpedromoreno](https://avatars2.githubusercontent.com/u/4879373?v=4&s=20) **juanpedromoreno**](https://github.com/juanpedromoreno)
27+
- [![fedefernandez](https://avatars0.githubusercontent.com/u/720923?v=4&s=20) **fedefernandez**](https://github.com/fedefernandez)
28+
- [![developer47deg](https://avatars1.githubusercontent.com/u/24799081?v=4&s=20) **developer47deg**](https://github.com/developer47deg)
29+
- [![jdesiloniz](https://avatars2.githubusercontent.com/u/2835739?v=4&s=20) **jdesiloniz**](https://github.com/jdesiloniz)
30+
- [![anamariamv](https://avatars0.githubusercontent.com/u/2183589?v=4&s=20) **anamariamv**](https://github.com/anamariamv)
31+
- [![calvellido](https://avatars0.githubusercontent.com/u/7753447?v=4&s=20) **calvellido**](https://github.com/calvellido)
32+
- [![AdrianRaFo](https://avatars0.githubusercontent.com/u/15971742?v=4&s=20) **AdrianRaFo**](https://github.com/AdrianRaFo)
33+
- [![mfirry](https://avatars0.githubusercontent.com/u/1107071?v=4&s=20) **mfirry**](https://github.com/mfirry)
34+
- [![mkobzik](https://avatars0.githubusercontent.com/u/18078706?v=4&s=20) **mkobzik**](https://github.com/mkobzik)
35+
- [![AntonioMateoGomez](https://avatars0.githubusercontent.com/u/25897490?v=4&s=20) **AntonioMateoGomez**](https://github.com/AntonioMateoGomez)
36+
- [![duanebester](https://avatars1.githubusercontent.com/u/2539656?v=4&s=20) **duanebester**](https://github.com/duanebester)
37+
- [![lloydmeta](https://avatars3.githubusercontent.com/u/914805?v=4&s=20) **lloydmeta**](https://github.com/lloydmeta)
38+
- [![aleksandr-vin](https://avatars2.githubusercontent.com/u/223293?v=4&s=20) **aleksandr-vin**](https://github.com/aleksandr-vin)
39+
- [![GRBurst](https://avatars1.githubusercontent.com/u/4647221?v=4&s=20) **GRBurst**](https://github.com/GRBurst)
40+
- [![JesusMtnez](https://avatars2.githubusercontent.com/u/8639179?v=4&s=20) **JesusMtnez**](https://github.com/JesusMtnez)
41+
- [![YarekTyshchenko](https://avatars0.githubusercontent.com/u/185304?v=4&s=20) **YarekTyshchenko**](https://github.com/YarekTyshchenko)
42+
- [![bond15](https://avatars1.githubusercontent.com/u/9124653?v=4&s=20) **bond15**](https://github.com/bond15)
43+
- [![pepegar](https://avatars0.githubusercontent.com/u/694179?v=4&s=20) **pepegar**](https://github.com/pepegar)
44+
- [![asoltysik](https://avatars2.githubusercontent.com/u/17353292?v=4&s=20) **asoltysik**](https://github.com/asoltysik)
45+
- [![dcsobral](https://avatars2.githubusercontent.com/u/141079?v=4&s=20) **dcsobral**](https://github.com/dcsobral)
46+
- [![drwlrsn](https://avatars3.githubusercontent.com/u/981387?v=4&s=20) **drwlrsn**](https://github.com/drwlrsn)
47+
- [![guersam](https://avatars3.githubusercontent.com/u/969120?v=4&s=20) **guersam**](https://github.com/guersam)
48+
- [![kalexmills](https://avatars0.githubusercontent.com/u/22620342?v=4&s=20) **kalexmills**](https://github.com/kalexmills)
49+
- [![mscharley](https://avatars0.githubusercontent.com/u/336509?v=4&s=20) **mscharley**](https://github.com/mscharley)
50+
- [![MaureenElsberry](https://avatars0.githubusercontent.com/u/17556002?v=4&s=20) **MaureenElsberry**](https://github.com/MaureenElsberry)
51+
- [![mikegirkin](https://avatars1.githubusercontent.com/u/4907402?v=4&s=20) **mikegirkin**](https://github.com/mikegirkin)

CODE_OF_CONDUCT.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
[comment]: <> (Don't edit this file!)
2+
[comment]: <> (It is automatically updated after every release of https://github.com/47degrees/.github)
3+
[comment]: <> (If you want to suggest a change, please open a PR or issue in that repository)
4+
15
# Code of Conduct
26

37
We are committed to providing a friendly, safe and welcoming
@@ -6,14 +10,13 @@ identity and expression, sexual orientation, disability, personal
610
appearance, body size, race, ethnicity, age, religion, nationality, or
711
other such characteristics.
812

9-
Everyone is expected to follow the [Scala Code of Conduct] when
13+
Everyone is expected to follow the
14+
[Scala Code of Conduct](https://typelevel.org/code-of-conduct.html) when
1015
discussing the project on the available communication channels. If you
1116
are being harassed, please contact us immediately so that we can
1217
support you.
1318

1419
## Moderation
1520

1621
For any questions, concerns, or moderation requests please contact a
17-
[member of the project](AUTHORS.md#maintainers).
18-
19-
[Scala Code of Conduct]: https://typelevel.org/code-of-conduct.html
22+
[member of the project](AUTHORS.md#maintainers).

CONTRIBUTING.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,31 @@
1+
[comment]: <> (Don't edit this file!)
2+
[comment]: <> (It is automatically updated after every release of https://github.com/47degrees/.github)
3+
[comment]: <> (If you want to suggest a change, please open a PR or issue in that repository)
4+
15
# Contributing
26

3-
Discussion around Github4s happens in the [Gitter channel](https://gitter.im/47degrees/github4s) as well as on
4-
[GitHub issues](https://github.com/47degrees/github4s/issues) and [pull requests](https://github.com/47degrees/github4s/pulls).
7+
Discussion around _github4s_ happens in the [GitHub issues](https://github.com/47degrees/github4s/issues) and [pull requests](https://github.com/47degrees/github4s/pulls).
58

69
Feel free to open an issue if you notice a bug, have an idea for a feature, or have a question about
710
the code. Pull requests are also welcome.
811

9-
People are expected to follow the [Scala Code of Conduct](https://typelevel.org/code-of-conduct.html) when discussing Github4s on the Github page, Gitter channel, or other venues.
12+
People are expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md) when discussing _github4s_ on the Github page or other venues.
1013

11-
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:[email protected]).
14+
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 Open Source](mailto:[email protected]).
1215

1316
## How can I help?
1417

15-
Github4s follows a standard [fork and pull](https://help.github.com/articles/using-pull-requests/) model for contributions via GitHub pull requests.
18+
_github4s_ follows a standard [fork and pull](https://help.github.com/articles/using-pull-requests/) model for contributions via GitHub pull requests.
1619

1720
The process is simple:
1821

1922
1. Find something you want to work on
20-
2. Let us know you are working on it via the Gitter channel or GitHub issues/pull requests
23+
2. Let us know you are working on it via GitHub issues/pull requests
2124
3. Implement your contribution
2225
4. Write tests
2326
5. Update the documentation
2427
6. Submit pull request
2528

2629
You will be automatically included in the [AUTHORS.md](AUTHORS.md#contributors) file as contributor in the next release.
30+
2731
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.

0 commit comments

Comments
 (0)