ZencypherSolutions / semaphore-stellar-contracts

MIT License
0 stars 0 forks source link

docs: add PR template #6

Open evgongora opened 2 hours ago

evgongora commented 2 hours ago

The doc must have: Summary, Changes Made, Related Issues, Checklist with brief description on each one or bullet points.

Example:

image

sanieni6 commented 2 hours ago

I'd love to work on this! I am a front end dev, i am familiar with ci workflows, please allow me to work on tnis.

diegoTech14 commented 2 hours ago

Hello, I'm Diego a software engineer from Costa Rica and member of Dojo Coding ⛩️ I've created some documentation for projects like KaizenNodeLabs, ByteBeasts and Dipdup, I would love to contribute to this issue

You can see my OnlyDust profile here

NueloSE commented 2 hours ago

Can I work on this, please?

t0fudev commented 1 hour ago

Hi, I'm currently a software enginner student. I am confident of completing this task successfully.

I would do the following to solve the task:

JosueBrenes commented 1 hour ago

Hi, I'm Josué Brenes and I'll be working on issue. I'm Dojo Coding member. ⛩️

I estimate this will take 1 day to complete.

Solution Plan

Step 1: Document Structure

I'll start by creating a structured document that includes sections for Summary, Changes Made, Related Issues, Other Information, and Checklist.

Step 2: Detailed Sections

Step 3: Markdown Format

I'll format each section in GitHub Markdown to ensure clarity and easy reading. This includes adding checkboxes for each item in the checklist.

Step 4: Save as Template

Finally, I'll save the document as a reusable template to maintain consistency across future issues.

Expected Outcome

A structured, reusable template for documenting issue resolutions, with a clear checklist and all necessary information for reviewers.