search

hoeck / simple-runtypes

Small, efficient and extendable runtype library for Typescript
MIT License
114 stars 5 forks source link

Fix minor spelling, grammar, and styling issues in README #59

Closed remnantkevin closed 2 years ago

hoeck commented 2 years ago

Thanks for fixing the README.

Did you do that manually or are you using a browser plugin or some spellchecking software?

remnantkevin commented 2 years ago

Thanks for fixing the README.

Did you do that manually or are you using a browser plugin or some spellchecking software?

Happy to help 🙂

I did it manually -- I have a bit of writing experience from my university studies (which included social science subjects) and from a short time working at a news site.

I'm using simple-runtypes in a small side project of mine, and so wanted to help out / improve where I can. There are some other small improvements I would like to suggest for the readme, so I'll open an issue/PR for that.

I'd also like to take a stab at improving some of the code doc comments (JSDoc) so that they display nicely in code editor intellisense/autocomplete. I'd open an issue before doing that.

However, please let me know if you'd prefer to not have these kinds of contributions -- I'm keen to help/contribute, but don't want to step on anyone's toes.

hoeck commented 2 years ago

I'm using simple-runtypes in a small side project of mine, and so wanted to help out / improve where I can. There are some other small improvements I would like to suggest for the readme, so I'll open an issue/PR for that.

:+1:

I'd also like to take a stab at improving some of the code doc comments (JSDoc) so that they display nicely in code editor intellisense/autocomplete. I'd open an issue before doing that.

That sounds like a great idea. As an Emacs user I do not really know how to write doc comments that look good in other IDEs/editors so I would appreciate your help :grin:.

However, please let me know if you'd prefer to not have these kinds of contributions -- I'm keen to help/contribute, but don't want to step on anyone's toes.

Thx for asking, I am all open to contributions as long as the core spirit (simplicity?) of the project is somehow kept intact.