typer/docs/help-typer.md

93 lines
4.1 KiB
Markdown
Raw Normal View History

2019-12-24 13:31:59 +01:00
Are you liking **Typer**?
Would you like to help Typer, other users, and the author?
Or would you like to get help with **Typer**?
There are very simple ways to help (several involve just one or two clicks).
And there are several ways to get help too.
## Star **Typer** in GitHub
2020-01-17 16:27:17 +01:00
You can "star" Typer in GitHub (clicking the star button at the top right): <a href="https://github.com/tiangolo/typer" class="external-link" target="_blank">https://github.com/tiangolo/typer</a>.
2019-12-24 13:31:59 +01:00
By adding a star, other users will be able to find it more easily and see that it has been already useful for others.
## Watch the GitHub repository for releases
2020-01-17 16:27:17 +01:00
You can "watch" Typer in GitHub (clicking the "watch" button at the top right): <a href="https://github.com/tiangolo/typer" class="external-link" target="_blank">https://github.com/tiangolo/typer</a>.
2019-12-24 13:31:59 +01:00
There you can select "Releases only".
Doing it, you will receive notifications (in your email) whenever there's a new release (a new version) of **Typer** with bug fixes and new features.
## Connect with the author
2020-01-17 16:27:17 +01:00
You can connect with <a href="https://tiangolo.com" class="external-link" target="_blank">me (Sebastián Ramírez / `tiangolo`)</a>, the author.
2019-12-24 13:31:59 +01:00
You can:
2020-01-17 16:27:17 +01:00
* <a href="https://github.com/tiangolo" class="external-link" target="_blank">Follow me on **GitHub**</a>.
2019-12-24 13:31:59 +01:00
* See other Open Source projects I have created that could help you.
* Follow me to see when I create a new Open Source project.
2020-01-17 16:27:17 +01:00
* <a href="https://twitter.com/tiangolo" class="external-link" target="_blank">Follow me on **Twitter**</a>.
2019-12-24 13:31:59 +01:00
* Tell me how you use Typer (I love to hear that).
* Ask questions.
2020-01-17 16:27:17 +01:00
* <a href="https://www.linkedin.com/in/tiangolo/" class="external-link" target="_blank">Connect with me on **Linkedin**</a>.
2019-12-24 13:31:59 +01:00
* Talk to me.
* Endorse me or recommend me :)
* Read what I write (or follow me):
* Read other ideas, articles and tools I have created.
* Follow me to see when I publish something new.
2020-01-17 16:27:17 +01:00
* On <a href="https://dev.to/tiangolo" class="external-link" target="_blank">**Dev.to**</a>.
* On <a href="https://medium.com/@tiangolo" class="external-link" target="_blank">**Medium**</a>.
2019-12-24 13:31:59 +01:00
## Tweet about **Typer**
2020-01-17 16:27:17 +01:00
<a href="https://twitter.com/compose/tweet?text=I'm loving Typer because... https://github.com/tiangolo/typer cc @tiangolo" class="external-link" target="_blank">Tweet about **Typer**</a> and let me and others know why you like it.
2019-12-24 13:31:59 +01:00
## Let me know how are you using **Typer**
I love to hear about how **Typer** is being used, what have you liked in it, in which project/company you are using it, etc.
You can let me know:
2020-01-17 16:27:17 +01:00
* <a href="https://twitter.com/compose/tweet?text=Hey @tiangolo, I'm using Typer at..." class="external-link" target="_blank">On **Twitter**</a>.
* <a href="https://www.linkedin.com/in/tiangolo/" class="external-link" target="_blank">On **Linkedin**</a>.
* <a href="https://dev.to/tiangolo" class="external-link" target="_blank">On **Dev.to**</a>.
* <a href="https://medium.com/@tiangolo" class="external-link" target="_blank">On **Medium**</a>.
2019-12-24 13:31:59 +01:00
## Help others with issues in GitHub
2020-01-17 16:27:17 +01:00
You can see <a href="https://github.com/tiangolo/typer/issues" class="external-link" target="_blank">existing issues</a> and try and help others.
2019-12-24 13:31:59 +01:00
## Watch the GitHub repository
2020-01-17 16:27:17 +01:00
You can "watch" Typer in GitHub (clicking the "watch" button at the top right): <a href="https://github.com/tiangolo/typer" class="external-link" target="_blank">https://github.com/tiangolo/typer</a>.
2019-12-24 13:31:59 +01:00
If you select "Watching" instead of "Releases only", you will receive notifications when someone creates a new issue.
Then you can try and help them solving those issues.
## Create issues
2020-01-17 16:27:17 +01:00
You can <a href="https://github.com/tiangolo/typer/issues/new/choose" class="external-link" target="_blank">create a new issue</a> in the GitHub repository, for example to:
2019-12-24 13:31:59 +01:00
* Report a bug/issue.
* Suggest a new feature.
* Ask a question.
## Create a Pull Request
2020-01-17 16:27:17 +01:00
You can <a href="https://github.com/tiangolo/typer" class="external-link" target="_blank">create a Pull Request</a>, for example:
2019-12-24 13:31:59 +01:00
* To fix a typo you found on the documentation.
* To propose new documentation sections.
* To fix an existing issue/bug.
* To add a new feature.
---
Thanks!