search

ZencypherSolutions / semaphore-stellar-sdk

MIT License
0 stars 3 forks source link

[Semaphore SDK] Issue 1: Add the PR template and Readme files #1

Closed evgongora closed 10 hours ago

evgongora commented 4 days ago

The Semaphore-Stellar SDK needs an updated README file to include a clear explanation of what it is and how to use it. Additionally, a standardized pull request (PR) template, similar to the format used in other repositories, should be created to streamline the contribution process and ensure consistency across PRs.

Jemiiah commented 4 days ago

Hello I would love to work on this issue

raizo07 commented 4 days ago

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

NueloSE commented 4 days ago

Let me handle this issue! I will ensure it covers the following:

  1. A comprehensive README that includes:
  1. A detailed PR template with:

Finally to implement it i would save these file in:

  1. README.md in the root repository and
  2. Will create a .github/pull_request_template.md file
martinvibes commented 4 days ago

Mind if I try this one? hey i would love to work on this issue kindly assign i have done multiple issues like this multiple times https://github.com/ZencypherSolutions/semaphore-stellar-docs/pull/6

mimisavage commented 4 days ago

Is it okay if I take this?

zintarh commented 4 days ago

Can I handle this task?

mexes20 commented 4 days ago

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 proper template with ensuing guidelines.

ETA: 10 hours.

starknetbrother commented 4 days ago

Is this issue still available?

caxtonacollins commented 4 days ago

Let me handle this issue!

Iwueseiter commented 4 days ago

Can I contribute to this one? 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, https://github.com/cairo-book/cairo-book/pull/1019, https://github.com/horuslabsio/tokenbound-contract-docs/pull/12, https://github.com/sivicstudio/starkludo/pull/102, https://hackmd.io/@-__sK8xkRjuXHkFZQLyYXg/HkLcMImM1l.

pheobeayo commented 4 days ago

Would love to tackle this!

I am a Web3 front-end developer skilled in technical documentation and software development. I greatly understand technologies like JavaScript, Typescript, Cairo, Rust and Solidity. I have contributed successfully to open-source projects like Stark Quest and Speedrun scaffold-stark.

How I Plan to tackle this -Write a well-structured template containing the needed information using the correct references for a PR template outlining the parts needed as instructed.

Benjtalkshow commented 4 days ago

Can I try solving this issue?

josephpdf commented 4 days ago

Hi! @evgongora I'm Joseph Poveda, I'm a member of the Dojo Coding community. A bit about my background is that I'm just starting out with Only Dust and I want to contribute as much as I can to the project. My knowledge of different programming languages ​​will allow me to better solve problems. To solve this issue I will:

  1. Update the README File:
    • Provide a clear explanation of what the Semaphore-Stellar SDK is.
    • Include detailed instructions on how to use the SDK.
  2. Create a Standardized PR Template:
    • Draft a pull request template that includes sections for a brief summary of changes, a checklist for key aspects (e.g., tests added, documentation updated), and sections for linking related issues and providing additional context.
    • Ensure the template is similar to those used in other repositories for consistency.
  3. Review and Refine:
    • Review both the README and the PR template for clarity and completeness.
    • Refine based on feedback from the team.
  4. Implement and Test:
    • Implement the updated README and PR template in the repository.
    • Test the new documentation and template to ensure they are effective and user-friendly.
aguilar1x commented 4 days ago

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

2. Create Introduction

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

Template for PR

Pull Request Overview

📝 Summary

🔄 Changes Made

🔧 Tests Results

🔜 Next Steps

README.md

The corresponding README.md will be created in a repository with:

  1. Project information
  2. Project structure
  3. Video presentation or page
  4. Team Members
  5. Technologies used
  6. And installation of the repository on its main fork

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

SudiptaPaul-31 commented 4 days ago

Will love to work on this issue.

akintewe commented 4 days ago

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

Michaelkingsdev commented 4 days ago

I’d like to resolve this.

ryzen-xp commented 4 days ago

Can I contribute to this one?

salazarsebas commented 4 days ago

My background

As a member of the Dojo Coding community, I have experience in web2 and traditional technologies, as for web3 I have only been working for a few months and I have managed to make a few contributions, however, it is not an impediment for me to do my best in this issue, I will dedicate the necessary effort to contribute to the OSS.

How I plan on tackling this issue

To solve this issue, I will perform the following steps:

Use the context and suggestions to come up with the best solution to the issue.

vestor-dev commented 4 days ago

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

petersdt commented 4 days ago

Can I try solving this issue?

jsandinoDev commented 4 days ago

Hi I'm a full-stack developer from Costa Rica and member of Dojo coding. I've worked on projects using React, Solidity, Cairo, and blockchain tools. My skills in both front-end and back-end development allow me to build scalable and secure solutions for web3 ecosystems.

For this issue I will:

  1. Review Existing Documentation • Examine the current README file to identify missing or unclear information. • Look for gaps in the description, installation instructions, usage examples, or contribution guidelines.
  2. Draft an Updated README • Define the target audience (e.g., developers familiar with Stellar or Semaphore). • Outline key sections, such as: • Overview: A concise explanation of the SDK’s purpose. • Installation: Clear steps to set it up. • Usage: Code examples showcasing core functionality. • Contribution: Instructions for contributing to the repository.
  3. Create a Pull Request Template • Review PR templates from similar repositories for inspiration. • Ensure the template includes sections like: • Description of Changes: What the PR addresses. • Steps to Test: How reviewers can verify the changes. • Checklist: A list to ensure code quality and testing.