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

Add Requirements and Dependencies Section to the README #4

Closed
sasasamaes opened this issue Nov 20, 2024 · 18 comments · Fixed by #22
Closed

Add Requirements and Dependencies Section to the README #4

sasasamaes opened this issue Nov 20, 2024 · 18 comments · Fixed by #22
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers ODHack10

Comments

@sasasamaes
Copy link
Collaborator

sasasamaes commented Nov 20, 2024

Enhance the README file by adding a section that lists the requirements and dependencies needed to set up and run the project.

The section should include:

•	Minimum hardware or software requirements (e.g., OS, RAM).
•	Dependencies and their versions (e.g., Node.js, Python, frameworks, libraries).
•	Any necessary tools or packages to install before running the project.

Ensure the information is clear and organized, helping contributors and users set up the project easily.

@sasasamaes sasasamaes added documentation Improvements or additions to documentation good first issue Good for newcomers labels Nov 20, 2024
@aguilar1x aguilar1x transferred this issue from another repository Nov 21, 2024
@Kingsuite
Copy link

Could I take over this issue?

@aguilar1x aguilar1x added enhancement New feature or request ODHack10 labels Nov 21, 2024
@raizo07
Copy link

raizo07 commented Nov 21, 2024

Could I be assigned to this? I'm a software developer with over four years of experience

@abdegenius
Copy link

I'd love to give this a go. I can comfortably handle this issues

@BrunoAmbricca
Copy link

I would like to work on this issue

@josephchimebuka
Copy link

Would love to tackle this!

@0xdevcollins
Copy link

Can I jump on this task?

My Background
I am a Full Stack Blockchain Developer with proficiency in Solidity/Rust, Next.js, TypeScript, React, and Node.js. I've demonstrated my ability to adjust to a variety of requirements, perform well under pressure, and reliably produce user-centric blockchain solutions with 46 significant contributions spread over 10 OnlyDust projects.

@Benjtalkshow
Copy link
Contributor

I'd like to take this issue.

@Iwueseiter
Copy link

Can I jump on this task?
I'm a frontend/smart contract developer and a technical writer.
Here are links to comprehensive docs I've written and have been merged Flex-NFT-Marketplace/Flex-Marketplace-Contract#107, cairo-book/cairo-book#1019, horuslabsio/tokenbound-contract-docs#12, sivicstudio/starkludo#102, https://hackmd.io/@-__sK8xkRjuXHkFZQLyYXg/HkLcMImM1l.

@Awointa
Copy link

Awointa commented Nov 21, 2024

I would appreciate the opportunity of working on this issue

@ShantelPeters
Copy link

Is this issue still available?

@martinvibes
Copy link

Can I take care of this issue?
i'm a frontend dev and a blockchain dev kindly assign :)

@akintewe
Copy link

Hello can i be assigned this issue, i am a new contributor, i would love to work on this , my ETA is >12 Hours and ill create a draft PR in 10 hours time. Thank you for this opportunity. :)

@Bran18
Copy link
Contributor

Bran18 commented Nov 21, 2024

Hello there guys , I’m Brandon, part of the ⛩️ Dojo Coding community, and I would love to contribute to this project! 🚀 This might be my first contribution here, and I would be very happy for it to be on your project. I’ve always known this one would fire since the ETH day when we were talking about.

I’ve collaborated on a couple of these ones in our Open Source products at Bitcash.app and the other ones, and I believe I can genuinely help by creating the one you need for all the collaborators.

Lmk if I can start working on it. Here’s my GitHub profile: GitHub: https://github.com/Bran18 and my OnlyDust profile: https://app.onlydust.com/u/Bran18.

BTW tks for taking the time 🙏

@od-hunter
Copy link

Hello can I be assigned this please? I am a blockchain developer and I'm also good at documentations.
This section will include minimum hardware or software requirements (e.g., OS, RAM), dependencies and their versions (e.g., Node.js, Python, frameworks, libraries) and any necessary tools or packages to install before running the project just as instructed. Below are some of the documentations I've done that were merged:

dojoengine/book#308,

keep-starknet-strange/joyboy#143,

Scaffold-Stark/ss2-docs#31,

horuslabsio/Starknet-Scaffold#94,

Hyle-org/examples#15,

Please I’m ready to work, assign me please.

@Aditya-040
Copy link

May I try my hand at this?

@derianrddev
Copy link
Contributor

Hello, my name is Derian Rodríguez. I am a passionate software engineer with over one year of experience, actively contributing to open-source projects through OnlyDust. My experience includes full-stack development with a focus on backend, frontend, and web3 development using Starknet and Cairo. Additionally, I am part of the Dojo Coding community. I would follow all the guidelines and instructions to get exactly what you want. I would love to contribute and support the development of this project.

@salazarsebas
Copy link
Collaborator

Assigned @derianrddev ! ⛩️

@derianrddev
Copy link
Contributor

derianrddev commented Nov 21, 2024

Thank you @salazarsebas, I will deliver asap!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers ODHack10
Projects
None yet
Development

Successfully merging a pull request may close this issue.