-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #26 from 47deg/contributing
Contributing and Authors
- Loading branch information
Showing
2 changed files
with
45 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Authors | ||
|
||
## Maintainers | ||
|
||
The mantainers of the project are: | ||
|
||
- Alejandro Gómez <[email protected]> | ||
- Raúl Raja <[email protected]> | ||
|
||
## Contributors | ||
|
||
These are the people that have contributed to Fetch in one way or another. | ||
|
||
- Pepe García <[email protected]> | ||
- Alessandro Lacava <[email protected]> |
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 |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Contributing | ||
|
||
Discussion around Fetch happens in the [Gitter channel](https://gitter.im/47deg/fetch) as well as on | ||
[GitHub issues](https://github.com/47deg/fetch/issues) and [pull requests](https://github.com/47deg/fetch/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 wellcome. | ||
|
||
|
||
People are expected to follow the [Typelevel Code of Conduct](http://typelevel.org/conduct.html) when | ||
discussing Cats on the Github page, Gitter channel, 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 deegrees](mailto:[email protected]). | ||
|
||
## How can I help? | ||
|
||
Fetch 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 | ||
3. Implement your contribution | ||
4. Write tests | ||
5. Update the documentation | ||
6. Add yourself to AUTHORS.md | ||
7. Submit pull request | ||
|
||
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. |