[Semaphore SDK] Issue 2: Create Code of Conducts Template and Contributing file for Semaphorse SDK

[evgongora]

To foster a welcoming and inclusive environment, the Semaphore SDK needs a Code of Conduct and a comprehensive Contributing file. These documents will ensure that contributors understand the expectations for participation and the processes for making contributions.

[ooochoche]

I would love to work on this issue

[petersdt]

Could I take on this issue?

I ensure it code of conduct contains the following:

• Standards
• Attribution : code adoption
• contributing to Semaphore SDK
• Getting Started
• Developmet Process
• making changes guide
• code style
• pull request process
• testing
• documentation
• issue reporting guide
• communication channel
• License

[mimisavage]

May I pick this up?

[Josue19-08]

Hi, I'm Josué, and I'm part of the Dojo Coding community. I have experience in programming languages such as Angular, React, C#, .NET, C++, PHP, Python, Java, Node.js, and JavaScript, among others. I'm passionate about software development and enjoy contributing to open-source projects, applying my knowledge to solve problems in a practical way. Additionally, I’m working on the project Citizen Of Arcanis, where I’ve had to use Unity, so I’m also skilled with this tool.

First, I will create a Code of Conduct using the Contributor Covenant as a foundation, highlighting respect and inclusion. Then, I'll make a Contribution file with clear steps to report issues, propose ideas, and submit pull requests. Finally, I will add both documents to the repository and link them in the README for everyone to see easily.

[mexes20]

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

ETA: 10 hours.

[wheval]

I'd like to handle this task.

[Benjtalkshow]

I'd like to handle this task.

[ShantelPeters]

I’d like to help with this.

[aguilar1x]

Good morning, My name is Matias Aguilar, I am a software development engineer with 1 year of experience in backend and some Frontend. I have worked on several issues on documentation so I already have an idea of how to implement everything and make it understandable and clean at the same time. I am a member of Dojo Coding, and I would really love to participate in the project with this issue.

Implementation and solution to the problem

I'm going to cover certain important points for the implementation of the docu, without leaving aside how I would start working on it

1. Fork Repository and create code in the same

• The Fork of the main repository of the project to my normal repository will be created.

• The code will be created with the name of "Contributors_Guide.md

• The corresponding template for code of conducts will be created, if necessary I will send you a message to know how you would like in terms of format

• The steps of everything will begin to be implemented.

2. Create Introduction

In this part there will be an introduction / explanation of guide lines to follow for the contribution

3. Issues

A section will be created to see the list of issues, such as a tracking of them.

3. Clean execution of a PR

The bases will be explained to be able to make a PR in the best possible and cleanest way, so a template of how to do it will be added.

4. Github Actions

The option of github actions will be included if you wish, to take control of the PR house when they send it.

5. Commits

In this section the guide lines of how to make a good very effective commits will be explained, since it is often what costs the most, which will be put step by step on how to do it in the simplest way. So the types of messages will be added depending on the issue

6. Branches

Finally, it would be the implementation of the braches, like several that the guide line mentions, it will be simple and effective for the contributor to understand in the best way. So in this part the branch for the main, dev, use of keywords for better reading will be explained.

Doubts and recommendations

I'm waiting for questions and recommendations on how you would like to carry out the implementation of the contribution_guide, so if you need any change or implementation of something or another. As I saw that they needed me to add social media links, I'm at your disposal

ETA

1 day

[akintewe]

Hello can i be assigned this issue, i am a new contributor and 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. :)

[gchimelu]

Could I take a shot at this? I would love to help you develop a clear Code of Conduct to make it easy for contributors to know exactly what to do when working on your project. As a contributor to other projects, I understand what a good contributing file should look like.

[Michaelkingsdev]

Let me try this one!

[od-hunter]

Hello can I be assigned this please? I am a blockchain developer and I'm also good at documentations. I'll provide code of conducts documentation and a comprehensive contributing file.

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.

[ryzen-xp]

Is it okay if I tackle this?

[vestor-dev]

hey sir I'd like to handle this task.
i'm a frontend developer and a blockchain dev
i would really love to contribute to your project
please kindly assign :)

[NueloSE]

Am a frontend dev and an experienced technical writer. Can I take this from here?
previous merge technical doc:

• bytebeast
• starknet foundry
• cairo book

[martinvibes]

hey sir I'd like to handle this task.
i'm a frontend developer and a blockchain dev
ZencypherSolutions/semaphore-stellar-docs#6
please kindly assign :)

[t0fudev]

Hello! My name is t0fudev and I'm currently a computer science student. I'm fully confident on tackling this issue successfully since I've worked before on this type of documentation. Also, I had contributed on this fantastic project on the last OD Hack.

I'm looking forward to continue contributing to this awesome project.
Best rewards!

ETA: 1 day