Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pitfall section in readme.md for newcomers #111

Merged
merged 2 commits into from
Jul 9, 2020
Merged

Pitfall section in readme.md for newcomers #111

merged 2 commits into from
Jul 9, 2020

Conversation

cklam2
Copy link
Contributor

@cklam2 cklam2 commented Jul 9, 2020

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

There are certain pitfalls for newcomers when using this library.

Issue Number: #91 and #109

What is the new behavior?

To avoid ppl searching for potential solutions in the closed issues it would be useful to have a list of tips and tricks for the most important pitfalls. New section Potential pitfalls in readme.md

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

Copy link
Collaborator

@arturovt arturovt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Co-authored-by: Artur Androsovych <arthurandrosovich@gmail.com>
@cklam2
Copy link
Contributor Author

cklam2 commented Jul 9, 2020

Thank @arturovt, applied the suggested improvements.

@arturovt arturovt requested a review from NetanelBasal July 9, 2020 14:14
@NetanelBasal NetanelBasal merged commit f2a59eb into ngneat:master Jul 9, 2020
@jaco-terbraak
Copy link

jaco-terbraak commented Jul 14, 2020

Thanks @cklam2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants