Skip to content

Commit

Permalink
added nocode guide
Browse files Browse the repository at this point in the history
  • Loading branch information
quenbyako committed Dec 21, 2020
1 parent b6fb067 commit 4a75810
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 58 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,12 +192,14 @@ Technically — yes. In practice — components don't require specific architect

Please read [contributing guide](https://github.com/xelaj/mtproto/blob/master/docs/en_US/CONTRIBUTING.md) if you want to help. And the help is very necessary!

**Don't want code?** Read [this](https://github.com/xelaj/mtproto/blob/master/docs/en_US/nocode_contributing.md) page! We love nocoders!

## TODO

- [x] Basic MTProto implementation
- [x] Implement all Methods for latest layer
- [x] Make TL Encoder/Decoder
- [ ] Get away from panics in parsing TL
- [x] Get away from panics in parsing TL
- [ ] Support MTProxy
- [ ] Support socks5 as well
- [ ] Multiple tests
Expand Down
31 changes: 31 additions & 0 deletions docs/en_US/nocode_contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Ways to contribute, without coding, in just 5-10 minutes

So, you're ready to help this project, but you don't wanna code? This guide is right for you! Plenty of you wonderful people have asked how to help but don't know how to create any algorithms or even hot to write programs on golang 😄

Fear not! There are lots of things you can do to help the project, and here we collected some amazing ideas how to make this project rock!

## Help Spread the Word

* Write any tutorials, cheatsheets or just a review (it must be honest) at any programming forums, blogs, etc. good one are [golangbridge](https://forum.golangbridge.org/), [google group](https://groups.google.com/g/golang-nuts), [ycombinator](https://news.ycombinator.com/newest), [Habr](https://habr.com), (habr also welcoming english posts btw), yandex zen, etc. or any telegram channels like [gogolang](https://t.me/gogolang) (if you found any other resources, add it, just create PR here)
* Tell your friends! I mean, literally, tell someone in person, or (if Covid is still around) via some digital mechanism like chat or Zoom. If your company or team works with telegram api, tell them about it! it's dead simple, but can really help!
* Share on Twitter, Reddit, Facebook, or odnoklassniki or even Friendster (jk). Anyway, post your review with link to this repo.

The more people that use the package - the better it will get. I can share with you (don't tell anyone!) that this package uses 10-50 unique people every day. it can grow up up to hundreds or even thousands. So int this community we can find amazing developers which can improve this project!

## Send bug reports and ask questions

This is one of the most important contributions in any package for improving stability. Found bug? Create issue. Have some problems? ask it! (just don't ask about what food does love your cat, i mean, problems with this package)

## Improve docs or tell us about hacking package

* Did you learn how to do something cool in mtproto but it wasn't obvious on first try? You can contribute to our documentation!
* Docs doesn't cover some specific things? tell us about that!
* you know how to do something, which this package doesn't fit? Cool, share this info about that!

## Improve current TL schema!

Unfortunately, native telegram tl schema doesn't have docs. But we love docs! So just copypaste it from official telegram docs, it would be amazing contribution!

## Another ways to contribute

This is not **full** list of ideas, how to help this project. Wait, i got another one idea: if you have more nocode contributing ideas: **make PR, post this idea here!** No seriously, we can even make standard guide how to contribute for nocoders like code of conduct but in another way, you know, "code of nocode contributors" 🙃
57 changes: 0 additions & 57 deletions docs/ru_RU/README_old.md

This file was deleted.

31 changes: 31 additions & 0 deletions docs/ru_RU/nocode_contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Способы внести свой вклад без кода всего за 5-10 минут

Итак, вы готовы помочь этому проекту, но не хотите писать код? Это руководство написано специально для вас! Многие из вас спрашивали, как помочь в развитии проекта, но не все умеют писать какие-либо алгоритмы или даже не умеют писать программы на го 😄

Но боятся не нужно! Есть много проблем, которые вы можете решить, чтобы помочь проекту! Так что здесь мы собрали несколько замечательных идей, как сделать этот проект лучше!

## Помогите распостранить информацию

* Напишите туториалы, cheatsheets или просто обзор (только чур честный) на любых форумах разработки, в блогах и подобных местах. Хорошими вариантами являются [golangbridge](https://forum.golangbridge.org/), [группа в Google](https://groups.google.com/g/golang-nuts), [ycombinator](https://news.ycombinator.com/newest), [Habr] (http://habr.com), (хабр кстати приветствует английские посты, можете писать на английском), яндекс дзен и т. д. или любые телеграммы, такие как [gogolang](https://t.me/gogolang) (если вы нашли какие-либо другие ресурсы, добавьте их, просто создайте PR, в котором допишите еще интересные места)
* Друзьям расскажите своим! Ну типа, прям буквально, поделитесь информацией об этом проекте с кем-нибудь лично или (если в вашем будущем из-за ковида еще ничего не открылось) через какой-нибудь цифровой механизм, типа чатов, или зума. А если ваша компания или команда работает с апи телеграма, то это еще лучше, поделитесь с ними! Это очень просто, но действительно может помочь!
* Share on Twitter, Reddit, Facebook, or odnoklassniki or even Friendster (jk). Anyway, post your review with link to this repo.

The more people that use the package - the better it will get. I can share with you (don't tell anyone!) that this package uses 10-50 unique people every day. it can grow up up to hundreds or even thousands. So int this community we can find amazing developers which can improve this project!

## Send bug reports and ask questions

This is one of the most important contributions in any package for improving stability. Found bug? Create issue. Have some problems? ask it! (just don't ask about what food does love your cat, i mean, problems with this package)

## Improve docs or tell us about hacking package

* Did you learn how to do something cool in mtproto but it wasn't obvious on first try? You can contribute to our documentation!
* Docs doesn't cover some specific things? tell us about that!
* you know how to do something, which this package doesn't fit? Cool, share this info about that!

## Improve current TL schema!

Unfortunately, native telegram tl schema doesn't have docs. But we love docs! So just copypaste it from official telegram docs, it would be amazing contribution!

## Another ways to contribute

This is not **full** list of ideas, how to help this project. Wait, i got another one idea: if you have more nocode contributing ideas: **make PR, post this idea here!** No seriously, we can even make standard guide how to contribute for nocoders like code of conduct but in another way, you know, "code of nocode contributors" 🙃

0 comments on commit 4a75810

Please sign in to comment.