Hacktoberfest 2024 Ideas

[AlexStormwood]

It's that wonderful time of year again! Hacktoberfest is upon us!

I'm about to add the label to this repo for Hacktoberfest participation, but I realised... what does this repo actually need from Hacktoberfest? Or, how could Hacktoberfest participants do something meaningful with this repo?

Well, I love Hacktoberfest - especially when it was granting comfortable T-shirts for participation - and so I've had a few ideas of what I would want to do in a repo to make some meaningful contributions for the month. The ideas:

• Make a "dogfooding" or "example" repo on your own account, and then make a PR on this repo to just add a hyperlink that points to your example repo.
  • Example projects should get added as a list item in the Example Projects section of this repository's readme.
  • URLs to example projects added to that readme section are visible on both GitHub and NPM. The example project's GitHub repo should be publicly visible so that the links work!
• Improve the package's documentation.
  • This is my first major TypeScript project. I'm sure I've missed something or done something poorly, and I know that there are some parts of the Typedoc documentation that aren't done very well. Improvements here would be very welcomed.
• Improve this package's error handling and error declarations.
  • I was getting kinda fed-up with some of the error-focused TDD while doing the TypeScript overhaul, so some errors aren't as specific as they could be. I think the document delete errors in particular could be more-specific.
  • Keep in mind that the errors don't have to be complex or do much - they're really just a helper for any catch specificity.
• The big tough one: optimise the package to reduce database calls without impacting its functionality.
  • Something feels off about how I've implemented validation in this package. Not sure what. There's a heap of database calls in some functions, which I'm sure could be trimmed down. Just haven't put thought towards the "how" for that yet - I need a breather after reaching that big milestone of the TypeScript overhaul!

Hacktoberfest is really fun, and I'm hoping that I can help you have a great month with these ideas! Of course, anything not listed above but still suitable is very welcome as well - this package is open source!