search

sivicstudio / starkludo

Ludo game on Starknet
https://starkludo.com
MIT License
11 stars 44 forks source link

Improve codebase documentation #39

Closed princeibs closed 2 months ago

princeibs commented 2 months ago

Improve the documentation of both the client and onchain codebase

EjembiEmmanuel commented 2 months ago

@princeibs I'd love to work on this

onlydustapp[bot] commented 2 months ago

Hi @EjembiEmmanuel! Maintainers during the ODHack # 7.0 will be tracking applications via OnlyDust. Therefore, in order for you to have a chance at being assigned to this issue, please apply directly here, or else your application may not be considered.

Mystic-Nayy commented 2 months ago

@princeibs can I work on this?

onlydustapp[bot] commented 2 months ago

Hi @Gift-Naomi! Maintainers during the ODHack # 7.0 will be tracking applications via OnlyDust. Therefore, in order for you to have a chance at being assigned to this issue, please apply directly here, or else your application may not be considered.

muheebyusufbaba1 commented 2 months ago

I'll hop on this one

onlydustapp[bot] commented 2 months ago

Hi @muheebyusufbaba1! Maintainers during the ODHack # 7.0 will be tracking applications via OnlyDust. Therefore, in order for you to have a chance at being assigned to this issue, please apply directly here, or else your application may not be considered.

ikemHood commented 2 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hello @princeibs, I am Ikem Peter a fullstack developer and have contribute to over 4 projects through Onlydust,

I would like to take on this issue...

ETA: 24hrs

How I plan on tackling this issue

Mystic-Nayy commented 2 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I am a technical writer I have so many experiences in documentation

How I plan on tackling this issue

I will document everything you added in the description

  1. Document Functions: Add clear comments to key functions, detailing their purpose, parameters, and return values.

  2. Refine Types: Replace any types in the client codebase with accurate TypeScript types to enhance type safety and clarity.

  3. Update README: Ensure the README files reflect these improvements, providing an overview of changes and usage instructions.

EjembiEmmanuel commented 2 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

@princeibs I'd love to work on this

How I plan on tackling this issue

I'd review the codebase and write a detailed documentation for each function.

muheebyusufbaba1 commented 2 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

i'm a full stack developer, worked on seversl similar projects

CollinsC1O commented 2 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

l'm a front end and also a smart contract developer. I will love to work on this

martinvibes commented 2 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

i am a block chain dev and technical writerwould love to take on this issue if you allow me

How I plan on tackling this issue

how i would go about it

Review the Codebase:

Go through both the client-side and on-chain codebase to identify key functions, parameters, and return values that need documentation.

Improve Documentation:

Client Codebase:

Document important functions, specifying what they do, their parameters, and their return values. On-chain Codebase: Do the same for the on-chain codebase, ensuring all significant functions are well-documented. Refine Data Types:

in the client codebase, search for variables that use the any type.

Replace these any types with the correct, specific data types to improve type safety and clarity. Update the Documentation:

Ensure that the newly added documentation is clear, concise, and follows any existing documentation standards used in the project.

Luluameh commented 2 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I am a frontend developer with experience in React.js,Cario, TypeScript, and various UI frameworks such as Mantine. My background in TypeScript and React.js provides a strong foundation for understanding and enhancing client-side codebases. Additionally, my familiarity with handling complex data types and UI components allows me to effectively document and refine both client and on-chain codebases.

In my previous projects, I've worked extensively with TypeScript, which has honed my skills in type inference and ensuring code accuracy. This experience is directly relevant to the task of replacing variables with the correct data types, as TypeScript's type system helps prevent bugs and enhances code readability. Moreover, my background in React and TypeScript equips me with the knowledge to properly document functions, their parameters, and return values, ensuring that both developers and future maintainers have a clear understanding of the code.

How I plan on tackling this issue

Document Important Functions:

Identify Key Functions: Start by reviewing the codebase to identify the most critical functions. Focus on those that are frequently used, complex, or have significant impact on the application's behavior. Document Parameters and Return Values: For each key function, document the purpose of the function, its parameters, and return values. Use clear, concise language and include examples if necessary. This documentation should be added directly in the codebase as comments or in a separate documentation file. Utilize TypeScript: Leverage TypeScript’s type annotations to provide clear information about the types of parameters and return values. This reduces ambiguity and helps with both documentation and development. Replace any with Correct Data Types:

Audit the Codebase: Conduct a thorough review of the client codebase to find instances where any is used. This includes checking function signatures, variable declarations, and component props. Determine Correct Data Types: Analyze the code and determine the correct data types for each any usage. This may involve understanding the data being handled and how it is used throughout the application. Refactor and Test: Replace any with the appropriate types. Ensure that the refactoring does not introduce new bugs by running existing tests and adding new ones if necessary. Update Documentation:

Consistent Documentation Format: Adopt a consistent format for documenting functions and their types across the codebase. This could be using JSDoc or other documentation tools that integrate well with TypeScript. Review and Improve: Regularly review the documentation for accuracy and completeness. Update it as the code evolves to ensure it remains useful and relevant. By leveraging my expertise in TypeScript and React, I can effectively enhance the clarity and usability of both the client and on-chain codebases. My approach ensures that functions are well-documented and type safety is enforced, leading to a more maintainable and robust codebase.

Kaminar-i commented 2 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

i'm a technical writer in the web3 space please let me work on this

How I plan on tackling this issue

I will document everything you added in the description

Document Functions: Add clear comments to key functions, detailing their purpose, parameters, and return values.

Refine Types: Replace any types in the client codebase with accurate TypeScript types to enhance type safety and clarity.

Update README: Ensure the README files reflect these improvements, providing an overview of changes and usage instructions.

Please let me work on this

MatiasAchucarro commented 2 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I am a passionate and results-driven web developer, currently deepening my knowledge in web3 technologies, Cairo, and open-source development through Dojo Coding. My skill set includes expertise in JavaScript, React, HTML, CSS, C# with .NET Entity Framework, and more. I also have experience with tools like Git, GitHub, SQL Server, and Postman. My focus has been on building solid web applications, from task lists to full-fledged CRUD systems, with front-end, back-end, and database integration.

This will be my first contribution to the open-source ecosystem, and I am excited to learn and collaborate on innovative projects, particularly those involving Cairo.

How I plan on tackling this issue

First, I would review the client code and the onchain environment to understand how the key functions work. Then, I would start documenting each function, clearly describing its parameters and return values. As I go along, I would replace any any type variables with the correct data types, ensuring everything is properly typed. Finally, I would do a review to make sure the documentation and types are accurate and clear before committing and opening a Pull Request.

onlydustapp[bot] commented 2 months ago

The maintainer princeibs has assigned muheebyusufbaba1 to this issue via OnlyDust Platform. Good luck!