-
Notifications
You must be signed in to change notification settings - Fork 75
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update documentation and other files (#457)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
- Loading branch information
1 parent
58816e8
commit a9c6c02
Showing
77 changed files
with
340 additions
and
87 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,51 @@ | ||
| [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: | ||
|
|
||
| * 47 Degrees (twitter: @47deg) <[47degdev](https://github.com/47degdev)> | ||
| - [ **Ana Mª Marquez (anamariamv)**](https://github.com/anamariamv) | ||
| - [ **Ben Fradet (BenFradet)**](https://github.com/BenFradet) | ||
| - [ **Fede Fernández (fedefernandez)**](https://github.com/fedefernandez) | ||
| - [ **Javier de Silóniz Sandino (jdesiloniz)**](https://github.com/jdesiloniz) | ||
| - [ **Juan Pedro Moreno (juanpedromoreno)**](https://github.com/juanpedromoreno) | ||
| - [ **Pepe García (pepegar)**](https://github.com/pepegar) | ||
| - [ **Rafa Paradela (rafaparadela)**](https://github.com/rafaparadela) | ||
|
|
||
| ## Contributors | ||
|
|
||
| These are the people that have contributed to the Github4s project: | ||
| These are the people that have contributed to the _github4s_ project: | ||
|
|
||
| - [ **BenFradet**](https://github.com/BenFradet) | ||
| - [ **rafaparadela**](https://github.com/rafaparadela) | ||
| - [ **47degdev**](https://github.com/47degdev) | ||
| - [ **juanpedromoreno**](https://github.com/juanpedromoreno) | ||
| - [ **fedefernandez**](https://github.com/fedefernandez) | ||
| - [ **developer47deg**](https://github.com/developer47deg) | ||
| - [ **jdesiloniz**](https://github.com/jdesiloniz) | ||
| - [ **anamariamv**](https://github.com/anamariamv) | ||
| - [ **calvellido**](https://github.com/calvellido) | ||
| - [ **AdrianRaFo**](https://github.com/AdrianRaFo) | ||
| - [ **mfirry**](https://github.com/mfirry) | ||
| - [ **mkobzik**](https://github.com/mkobzik) | ||
| - [ **AntonioMateoGomez**](https://github.com/AntonioMateoGomez) | ||
| - [ **duanebester**](https://github.com/duanebester) | ||
| - [ **lloydmeta**](https://github.com/lloydmeta) | ||
| - [ **aleksandr-vin**](https://github.com/aleksandr-vin) | ||
| - [ **GRBurst**](https://github.com/GRBurst) | ||
| - [ **JesusMtnez**](https://github.com/JesusMtnez) | ||
| - [ **YarekTyshchenko**](https://github.com/YarekTyshchenko) | ||
| - [ **bond15**](https://github.com/bond15) | ||
| - [ **pepegar**](https://github.com/pepegar) | ||
| - [ **asoltysik**](https://github.com/asoltysik) | ||
| - [ **dcsobral**](https://github.com/dcsobral) | ||
| - [ **drwlrsn**](https://github.com/drwlrsn) | ||
| - [ **guersam**](https://github.com/guersam) | ||
| - [ **kalexmills**](https://github.com/kalexmills) | ||
| - [ **mscharley**](https://github.com/mscharley) | ||
| - [ **MaureenElsberry**](https://github.com/MaureenElsberry) | ||
| - [ **mikegirkin**](https://github.com/mikegirkin) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +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 Github4s happens in the [Gitter channel](https://gitter.im/47degrees/github4s) as well as on | ||
| [GitHub issues](https://github.com/47degrees/github4s/issues) and [pull requests](https://github.com/47degrees/github4s/pulls). | ||
| Discussion around _github4s_ happens in the [GitHub issues](https://github.com/47degrees/github4s/issues) and [pull requests](https://github.com/47degrees/github4s/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 [Scala Code of Conduct](https://typelevel.org/code-of-conduct.html) when discussing Github4s on the Github page, Gitter channel, or other venues. | ||
| People are expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md) when discussing _github4s_ 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:[email protected]). | ||
| 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]). | ||
|
|
||
| ## How can I help? | ||
|
|
||
| Github4s follows a standard [fork and pull](https://help.github.com/articles/using-pull-requests/) model for contributions via GitHub pull requests. | ||
| _github4s_ 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 the Gitter channel or GitHub issues/pull requests | ||
| 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. |
Oops, something went wrong.