-
-
Notifications
You must be signed in to change notification settings - Fork 405
Feat: add contribution guidelines #5
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
Feat: add contribution guidelines #5
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a little on using typescript's type system properly, like using any type is discouraged and so on.
Co-authored-by: David Leal <halfpacho@gmail.com>
Co-authored-by: David Leal <halfpacho@gmail.com>
Co-authored-by: David Leal <halfpacho@gmail.com>
Co-authored-by: David Leal <halfpacho@gmail.com>
Co-authored-by: David Leal <halfpacho@gmail.com>
Co-authored-by: David Leal <halfpacho@gmail.com>
@raklaptudirm and @Panquesito7 thanks for the super awesome feedback. Already learned a lot with you both and added the semantic commit messages guidelines. |
Co-authored-by: David Leal <halfpacho@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another minor thing I noticed: You are inconsistent in your capitalization of lists. For (2?) lists you use
- foo.
- bar.
- baz.
and for the other ones you use
- Foo.
- Bar.
- Baz.
I'd recommend uppercasing the first letters of all list items, since these are separate sentences due to the periods separating them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left one comment, otherwise looks good to me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Fixes: #4
To add this contribution guidelines, I've used the contribution guidelines from the JavaScript Repo. Then, I changed the JavaScript-related things for TypeScript-related ones.
In the process, I've removed the test guidelines and some of the style guidelines because this project isn't fully set up yet. Also, I've used the TypeScript Standard Style in the style guide and hope it was the right decision.
Thanks for opportunity of working on this project :)