react18-tools / react18-global-store Goto Github PK

Help Needed: Documentation and Bug Fixes

Description

Our open-source library r18gs or React 18 Global Store is an essential tool for library builders to craft libraries with seamless state management. However, we've noticed that our documentation could be improved, and there may be a few bugs that need fixing to ensure the smooth functioning of the library.

Although, we have 100% unit test coverage, often times, some edge cases are discovered much later. We request you to try and test the library and open issues here if you find any bugs.

What We Need

1. Documentation Improvement: We require help in enhancing our documentation to make it more comprehensive and user-friendly. This includes updating existing documentation, adding examples, and clarifying any ambiguities.

2. Testing and validation: Although, we have 100% unit test coverage, often times, some edge cases are discovered much later. We request you to try and test the library and open issues here if you find any bugs. This will help us to improve the overall reliability and stability of the library.

How You Can Contribute

• Documentation: If you're proficient in TypeScript/JavaScript/React/Next.js, your expertise in improving our documentation would be invaluable. Whether it's writing new guides, updating existing ones, or providing examples, your contributions will help make our library more accessible to users.

Benefits for Contributors

• Showcase Your Skills: Contributing to our project provides you with an opportunity to showcase your expertise in React, Next.js and TypeScript. Your contributions will be visible to the entire community, allowing you to demonstrate your skills to potential employers or collaborators.

• Learning and Growth: Contributing to open-source projects is an excellent way to enhance your skills, learn from others, and gain practical experience in real-world software development scenarios.

Getting Started

• Fork the repository: https://github.com/react18-tools/react18-global-store
• Check out the existing issues to see what needs to be done.
• Comment on this issue to let us know what you're working on to avoid duplication of effort.
• Once you've made your changes, submit a pull request, and we'll review it as soon as possible.

Additional Information

• If you have any questions or need clarification on anything, feel free to ask in the comments below.
• Your contributions will be acknowledged in the project's contributors' list and documentation.
• Thank you in advance for your help in improving our library and making it more accessible to the community!

Upvote & Fund

• We're using Polar.sh so you can upvote and help fund this issue.
• We receive the funding once the issue is completed & confirmed by you.
• Thank you in advance for helping prioritize & fund our backlog.

Come on, very helpful status management. Need more documentation

Upvote & Fund

• We're using Polar.sh so you can upvote and help fund this issue.
• We receive the funding once the issue is completed & confirmed by you.
• Thank you in advance for helping prioritize & fund our backlog.

[Help Needed] Rectify Typedoc/JSDoc Documentation for withPlugins Higher-Order Function

1. Navigate to lib/r18gs/src/with-plugins.ts.
2. Examine the withPlugins function exported at the file's conclusion.
3. The type definition for the function returned by the withPlugins Higher-Order Function (HOF) functions appropriately.
4. However, despite this, VSCode IntelliSense fails to display the associated documentation comments.

Upvote & Fund

• We're using Polar.sh so you can upvote and help fund this issue.
• We receive the funding once the issue is completed & confirmed by you.
• Thank you in advance for helping prioritize & fund our backlog.