From 426d60055f63b40fe7fa4870b46d3dc1b9df5707 Mon Sep 17 00:00:00 2001 From: kataras <kataras2006@hotmail.com> Date: Tue, 29 Aug 2017 14:00:37 +0300 Subject: [PATCH] Give some instructions for new contributors Former-commit-id: 89caf418f5ce80c7c5bad637858b75e01186f1a8 --- .github/CONTRIBUTING.md | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 4ba8bbb0..479e1ee9 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,3 +1,37 @@ # Contributing -Read our [Code of Conduct](https://github.com/kataras/iris/tree/master/CODE_OF_CONDUCT.md). \ No newline at end of file +First of all read our [Code of Conduct](https://github.com/kataras/iris/tree/master/CODE_OF_CONDUCT.md). + +## 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 + * 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) + +## 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: + +* [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) +* [Iris, a modular web framework](https://medium.com/@corebreaker/iris-web-cd684b4685c7) +* [How to Turn an Android Device into a Web Server](https://twitter.com/ThePracticalDev/status/892022594031017988) +* [A URL Shortener Service using Go, Iris and Bolt](https://medium.com/@kataras/a-url-shortener-service-using-go-iris-and-bolt-4182f0b00ae7) + +### Social networks + +If you're part of any social network, do a post(or tweet if twitter) about Iris and what you love about it, many examples can be found, the most recent one is [that](https://www.facebook.com/eliaswalyba/posts/1462004807202379). + +### Work + +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