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 a Contributor’s Guide to the Repository #2

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

Add a Contributor’s Guide to the Repository #2

sasasamaes opened this issue Nov 20, 2024 · 17 comments · Fixed by #20
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

Create a detailed Contributor’s Guide to help new contributors understand the project’s workflow and guidelines.

The guide should include:

•	Steps for setting up the project locally.
•	Guidelines for submitting issues and pull requests.
•	Coding standards and style guide (if applicable).
•	Any other relevant information for contributors.

The file should be named CONTRIBUTING.md and placed in the root of the repository.

@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 Crypto-Jaguars/Issues Nov 21, 2024
@petersdt
Copy link

Let me handle this issue!

@Michaelkingsdev
Copy link

hello @sasasamaes
Can i take on this issue? I have the required expertise to create a well standard and detailed markdown documentation. I will make PR in 24hrs. Thnaks

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

Can I take care of this issue?

@josephchimebuka
Copy link

Can I attempt this issue?

@Akshola00
Copy link

Can I contribute to this one?

@mexes20
Copy link

mexes20 commented Nov 21, 2024

May I pick this up? I have three years experience in Software development and have contributed to some projects on OD here.

I'll setup a well written contributors guide that even a Newbie would understand at a glance and I'll follow proper standards and guidelines.

ETA: 10 hours.

@Benjtalkshow
Copy link
Contributor

Can I handle this task?

@Awointa
Copy link

Awointa commented Nov 21, 2024

I would like to take the challenge of writing a contributors guide

@SudiptaPaul-31
Copy link

Will love to work on this issue.

@ShantelPeters
Copy link

May I try my hand at this?

@martinvibes
Copy link

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

@od-hunter
Copy link

Hello can I be assigned this please? I am a blockchain developer and I'm also good at documentations. The guide I'll make will include Steps for setting up the project locally, Guidelines for submitting issues and pull requests, Coding standards and style guide (if applicable) and other relevant information for contributors.
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.

@gchimelu
Copy link

Can I jump on this task? I have experience helping projects create and improve their documentation, including working on a Contributor's guide, and I will be happy to take this up.

@EmmanuelAR
Copy link
Contributor

Can I contribute to this one? I will create the template, also im manteiner too so i have experience, Dojo coding member too!

@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.

@EmmanuelAR
Copy link
Contributor

Let's goooo thks team, I will start asap

@salazarsebas
Copy link
Collaborator

Good luck @EmmanuelAR 🫡⛩️

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.