From 5e0fb95f46bab5382836fafce8a79cb322ed5a46 Mon Sep 17 00:00:00 2001 From: kataras Date: Tue, 29 Aug 2017 14:11:36 +0300 Subject: [PATCH] Add more details for new contributors to the greater community. --- .github/CONTRIBUTING.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 479e1ee9e3..10d3ea1a1e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -5,20 +5,20 @@ First of all read our [Code of Conduct](https://github.com/kataras/iris/tree/mas ## PR 1. Open a new [issue](https://github.com/kataras/iris/issues/new) - * Write version of your local Iris - * Write version of your local Go programming language + * Write version of your local Iris. + * Write version of your local Go programming language. * Describe your problem, what did you expect to see and what you see instead. * If it's a feature request, describe your idea as better as you can * optionally, navigate to the [chat](https://kataras.rocket.chat/channel/iris) to push other members to participate and share their thoughts about your briliant idea. -2. Fork the [repository](https://github.com/kataras/iris) -3. Make your changes -4. Compare & Push the PR from [here](https://github.com/kataras/iris/compare) +2. Fork the [repository](https://github.com/kataras/iris). +3. Make your changes. +4. Compare & Push the PR from [here](https://github.com/kataras/iris/compare). ## Share ### Writing -Write an article about Iris in https://medium.com , https://dev.to or if you're a hackanthon at https://hacernoon.com, some examples: +Write an article about Iris in https://medium.com , https://dev.to or if you're being a hackathon at https://hackernoon.com, some examples: * [Iris Go vs .NET Core Kestrel in terms of HTTP performance](https://hackernoon.com/iris-go-vs-net-core-kestrel-in-terms-of-http-performance-806195dc93d5) * [Go vs .NET Core in terms of HTTP performance](https://medium.com/@kataras/go-vs-net-core-in-terms-of-http-performance-7535a61b67b8) @@ -34,4 +34,12 @@ If you're part of any social network, do a post(or tweet if twitter) about Iris Convince your colleagues to try the Iris web framework at dev environment and if they choose to proceed on production, contact with [us](mailto:kataras2006@hotmail.com?subject=Iris%20Production) for further instructions, if you need any help. -Many young people are choosing Iris for their postgraduate studies as well. \ No newline at end of file +Many young people are choosing Iris for their postgraduate studies as well. + +## Documentation + +We're preparing the new version of the [Build A Better Web, Together](https://github.com/kataras/build-a-better-web-together) Go book, which is a type of documentation of Iris web framework as well. + +If you want to be part of this and you've time for collaboration, please open a new [issue](https://github.com/kataras/build-a-better-web-together/issues/new) and write some words about yourself and your overall experience at tech. At the end of the day you will be granded with `write access` in order to push your sections without our approval at all. + +All new contributors of that book will receive prizes! \ No newline at end of file