Skip to content

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

Merged
merged 42 commits into from
Sep 28, 2022

Conversation

gefgu
Copy link
Contributor

@gefgu gefgu commented Sep 23, 2022

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 :)

@gefgu gefgu requested a review from raklaptudirm as a code owner September 23, 2022 19:52
Copy link
Member

@raklaptudirm raklaptudirm left a 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.

@gefgu gefgu requested a review from raklaptudirm September 24, 2022 12:29
@Panquesito7 Panquesito7 added the enhancement New feature or request label Sep 25, 2022
gefgu and others added 9 commits September 25, 2022 09:01
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>
@gefgu
Copy link
Contributor Author

gefgu commented Sep 25, 2022

@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>
Copy link
Contributor

@appgurueu appgurueu left a 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.

raklaptudirm
raklaptudirm previously approved these changes Sep 28, 2022
Copy link
Member

@raklaptudirm raklaptudirm left a 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.

Copy link
Member

@raklaptudirm raklaptudirm left a comment

Choose a reason for hiding this comment

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

LGTM

@appgurueu appgurueu merged commit 4411944 into TheAlgorithms:master Sep 28, 2022
@gefgu gefgu deleted the feat/add-contribution-guidelines branch September 28, 2022 17:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a contributing guidelines file
4 participants