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 #106

Closed
jimenezz22 opened this issue Oct 29, 2024 · 14 comments · Fixed by #111
Closed

Add Template for Pull Request #106

jimenezz22 opened this issue Oct 29, 2024 · 14 comments · Fixed by #111
Assignees
Labels
documentation Improvements or additions to documentation external-contributor Available for external contributors good first issue Good for newcomers ODHack 10

Comments

@jimenezz22
Copy link
Contributor

The template must have the following parts:

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

Use the following photo as an example:
Screenshot 2024-10-29 at 11 27 34 AM

@jimenezz22 jimenezz22 added documentation Improvements or additions to documentation good first issue Good for newcomers external-contributor Available for external contributors ODHack 10 labels Oct 29, 2024
@Jemiiah
Copy link

Jemiiah commented Oct 29, 2024

@jimenezz22 can I work on this issue I have great experience in documentation issue with an ETA : 24 hours
I have made btw 6 - 10 contribution to documentation issues from previous and past OD Hack
Flex-NFT-Marketplace/Flex-Marketplace-Contract#106
dipdup-io/stone-packaging#72
horuslabsio/Starknet-Scaffold#155
dragan2234/worldcoin-scroll-bridge#13
dragan2234/worldcoin-scroll-bridge#11
kfastov/worldcoin-bridge-linea#22

@Akshola00
Copy link

Could I try solving this?

@martinvibes
Copy link

May I try my hand at this?
Kindly assign :)

@mayasimi
Copy link

Could I be assigned to this issue?

I am new to the onlydust platform and would like to make this my first contribution to this platform and open source contribution .

kindly assign. Am experienced in Js and typescript. Opening to learning how to document in c-sharp

@CollinsC1O
Copy link

Would love to tackle this!

@MPSxDev
Copy link

MPSxDev commented Oct 29, 2024

I would love to take on this issue. I am a member of the Dojo Coding. I am immediately available. @jimenezz22

@derianrddev
Copy link
Contributor

Hello, I’m Derian, a software engineer focused on full-stack web development, and I’m currently part of Dojo Coding. I’d like to work on this issue.

Here’s how I would solve the issue:

Create the .github folder in the root of the repository.
Add the template within that folder with the parts described in the issue.
Save and upload the file to the repository.
If I have any questions, I’ll ask in the Telegram group as soon as possible.
I’ll open a PR and wait for your feedback.
I’ll make the necessary changes according to the PR review.

@Iwueseiter
Copy link

Hi @jimenezz22 can I implement this?

@JosueBrenes
Copy link

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.

To resolve this, I would create a Markdown template file (pull_request_template.md) in the .github directory of the repository. This file would include the required sections in Markdown format, making it automatically available in each Pull Request.

# Pull Request Overview

## 📝 Summary
- Closes #(issue)
- Brief description of the purpose of the Pull Request.

## 🔄 Changes Made
- List of code changes, specifying the modules or sections affected.

## 🧪 Tests Results
- Results of the tests executed.
  - Example: "Unit tests: 15/15 passed"
  - Example: "Integration tests: 10/10 passed"

## 🚀 Next Steps
- Pending actions or next steps if applicable (e.g., additional reviews or tests by other teams).

@DiegoB1911
Copy link

I'm a Full Stack Developer with two years of experience. I'm also a member of Dojo Coding, where I'm expanding my expertise in Cairo and Web3 technologies. I'm enthusiastic about learning, and becoming a part of this project.
To address this issue, I would take the following steps:

  1. Create the Template File:
    I would create a new file named pull_request_template.md.

  2. Define the Structure of the Template:
    I will adjust the pull_request_template.md file to include the required sections.

  3. Test the Template:
    I would ensure that the template works by creating a new pull request in the repository and verifying that it automatically populates the description area, allowing contributors to fill in the necessary details.

@akintewe
Copy link

Hello, i would love if i can be assigned this issue, this is my first too, I’d like to help with this. I am very familiar with the documentation architecture, and i would love to be given the opportunity to work on this. Thank you so much. ETA <6 hrs

@Kaminar-i
Copy link

Can I jump on this task?

@sigmadawg
Copy link

im a newbie contributor, i'd be grateful if you'd give me the opportunity to work in this.

@jimenezz22 jimenezz22 moved this from TODO 🥷 to In progress in ByteBeasts - External - Backlog Oct 30, 2024
@jimenezz22
Copy link
Contributor Author

assigned to you @derianrddev

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 external-contributor Available for external contributors good first issue Good for newcomers ODHack 10
Projects
Development

Successfully merging a pull request may close this issue.