Submission - rish-16 - Githubissues

nushackers / openhack-submissions

Submissions for OpenHack 2020 (https://openhack.nushackers.org/).

Apache License 2.0

4 stars 0 forks source link

Submission - rish-16 #2

Open rish-16 opened 4 years ago

rish-16 commented 4 years ago

Submission Details

Type of Submission:

[ ] 3 Pull requests
[x] Self-initiated open-source project

Link to open-source project: https://github.com/rish-16/Angelfire (leave a ⭐️if you 💛it!)

Additional information (optional): Angelfire is a JavaScript library that allows users to build fully-customisable context menus (the menu that shows up when you right-click something on a webpage) and drop-down menus.

You can add styles to the menus and can even add sub-menus (WIP). It takes in a config object containing the different options in the menu and the respective on-click events.

When building menus for any type of element, I've had to write a lot of code to create them. With Angelfire, you can quickly generate one with only a few lines of code.

More info on the README.

Comment below if you have any feedback!

chrisgzf commented 4 years ago

Hi @rish-16, I think this is very good effort for a day of work!

Before we accept this:

in the spirit of open-source, you'd want your project to be used by others as well, can you consider adding fallback fonts for non-macOS users?

Just some other tips:

most projects which use git encourage writing commit messages in imperative present tense as convention. It's not a standard but I would encourage you to do so from now on.
try to keep your commit messages descriptive (i.e. we should be able to easily tell what each commit changes by reading the commit message)

Once you make the change to the fonts, my team and I are ready to accept your submission. But since we are still at a very early stage of OpenHack, I'd like to offer you an (additional) challenge: write tests for your code (you could look up jest as a starting point) and achieve > 70% code coverage, and then proudly put a badge on your repository.

Have fun!

rish-16 commented 4 years ago

Hey @chrisgzf thanks for the looksee!

I'll add some fonts for windows as well.

Will also look up Jest. Haven't used it before. The idea of using badges sounds interesting. Will see what all I can add to the README.

Cheers :D

rish-16 commented 4 years ago

I've changed the fonts! @chrisgzf

Will move onto the Jest testing.

Also, thanks for organising OpenHack! It was super fun making this project (had it at the back of my mind but never really had the chance to implement it).

rish-16 commented 4 years ago

@chrisgzf any more things I have left before having my submission finalised?

chrisgzf commented 4 years ago

Hi @rish-16, congratulations! Your OpenHack submission is now accepted!

Please visit https://openhack.nushackers.org/congrats and fill up the form so that we can capture your details for the prizes.

We hope you had fun working on the challenge and we hope you will continue making open-source contributions, even outside of the event!

rish-16 commented 4 years ago

Will do, thanks Chris! Was a fun experience :D