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 template for Pull Request #1

Closed
4 tasks
salazarsebas opened this issue Nov 15, 2024 · 18 comments · Fixed by #18
Closed
4 tasks

Add template for Pull Request #1

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

Comments

@salazarsebas
Copy link
Collaborator

salazarsebas commented Nov 15, 2024

The template must have the following parts:

  • Title: Pull Request Overview
  • Summary
  • Changes Made
  • Tests Results
  • Next Steps

Use this as an example:

Pull Request Overview

📝 Summary

Provide a brief overview of what this PR accomplishes.

🪧 Related Issues

  • Closes #(issue)

🛠️ Type of Change

Mark with an x all the checkboxes that apply (like [x]).

  • 📝 Documentation (updates to README, docs, or comments)
  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • 👌 Enhancement (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)

🔄 Changes Made

What's Changed
Provide a clear and concise description of what you changed and why.

🔧 Tests Results

Describe the tests you performed to verify your changes.

🔜 Next Steps

Indicate actions or improvements to be taken after this PR, if applicable.

@salazarsebas salazarsebas added good first issue Good for newcomers documentation Improvements or additions to documentation labels Nov 20, 2024
@salazarsebas salazarsebas changed the title #1 Add template for Pull Request Add template for Pull Request Nov 20, 2024
@aguilar1x aguilar1x transferred this issue from another repository Nov 21, 2024
@NueloSE
Copy link

NueloSE commented Nov 21, 2024

Can I try solving this issue?
i have experience with writing technical documentation and will like to be a part of this project.

steps to implement:

  • I will create a .github/ directory.
  • in the .github directory i would create a PULL_REQUEST_TEMPLATE.md file containing all the required template to make a valid PR.

kindly assign me
ETA <= 5hrs

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

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

Can I jump on this task?I am a Front-end and smart contract developer. I am proficient in tailwind css, Next Js, Typescript, JavaScript, Cairo and Rust. I would love to contribute to this project.

@nov0ax
Copy link
Contributor

nov0ax commented Nov 21, 2024

I'd like to take this issue. I've worked on similar issues in the past and have a pretty clear idea how to takle this issue, already have a nice template that can help the team to have this ready today.
#dojocodingCR

@Akshola00
Copy link

Is this issue still available?

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

ETA: 10 hours.

@pheobeayo
Copy link

May I handle this issue?

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.
My Approach includes:

  • Write a well-structured template containing the needed information using the correct references for a PR templates outlining the parts needed as instructed.
  • Create a Pull Request (PR)
  • Request for a Review
  • Make changes based on the Review of the PR.

@Benjtalkshow
Copy link
Contributor

Could I try solving this?

@Iwueseiter
Copy link

Could I take a shot at this?

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

@SudiptaPaul-31
Copy link

Will love to work on this issue.

@ShantelPeters
Copy link

Can I handle this task?

@CollinsC1O
Copy link

I’d love to work on this task.

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

Yes, the templete will have Summary, Changes Made, Tests Results and Next Steps. 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.

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

@ManuelJG1999
Copy link
Collaborator

Hi @nov0ax
Thank you for your enthusiasm in contributing to our project.
Wishing you great success as you take on this task.

Any questions you may have, please let us know.

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.