Skip to content
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

HELP : Documentation and testing ( Technical / jest ) #84

Open
IntegerAlex opened this issue Oct 20, 2024 · 3 comments
Open

HELP : Documentation and testing ( Technical / jest ) #84

IntegerAlex opened this issue Oct 20, 2024 · 3 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed Test Any thing related to tests

Comments

@IntegerAlex
Copy link
Owner

Documentation :

  • Write docs in markdown for all features.
  • Create a concise example with each methods.
  • Write Blogs

Testing :

  • Write Unit test for every method.
  • Add Return type and side effects.
  • Test Whole framework and Create issues in repo.
@IntegerAlex IntegerAlex added bug Something isn't working documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers hacktoberfest Test Any thing related to tests labels Oct 20, 2024
@OAtulA
Copy link
Contributor

OAtulA commented Oct 29, 2024

I would like to help.

For the docs part

I can do what you said +
I can even write the jsdocs with the examples for the functions and or middlewares you need.
My writing is a bit human like and somewhat informal naturally, yet I can put in jargons and references.

Here are some of writings https://dev.to/oatula

Testing

I can do the testing too. Creating the issues individually for the components.
So that its easier for you too to check them.

@OAtulA
Copy link
Contributor

OAtulA commented Oct 29, 2024

Please assign me this

@IntegerAlex
Copy link
Owner Author

Go for it

@OAtulA OAtulA mentioned this issue Nov 23, 2024
IntegerAlex added a commit that referenced this issue Dec 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed Test Any thing related to tests
Projects
None yet
Development

No branches or pull requests

2 participants