search

kadenzipfel / smart-contract-vulnerabilities

A collection of smart contract vulnerabilities along with prevention methods
https://kadenzipfel.github.io/smart-contract-vulnerabilities/
1.63k stars 219 forks source link

Proposal: Implement Pull Request Template #43

Closed rakesh0x7 closed 1 month ago

rakesh0x7 commented 1 month ago

Hi, I'd like to propose adding a pull request template to this repository.

A pull request template can help contributors provide clear and consistent information about their changes, which can streamline the review process for everyone.

Proposed Template: I've included a draft pull request template below. We can modify it to fit the specific needs of this project.

image

I'm open to discussing the proposed template and tailoring it to the specific needs of this project.

Please let me know your thoughts on implementing a pull request template.

kadenzipfel commented 1 month ago

Nice, yeah would be a great feature. I think we can drop the screenshots section though. Would also be good to add a template for issues, but in general I think we should aim to keep both simple

rakesh0x7 commented 1 month ago

Hey @kadenzipfel ,

Thanks for the feedback on the pull request template! The simple and focused approach is definitely a good idea.

I've attached an updated pull request template (refer to the image) that incorporates your suggestions. Do you have any further suggestions for improvement on the pull request template?

Capture

For the issue template, I noticed you previously mentioned creating astyle-guide.md #38. In light of that, would you prefer the attached issue template (refer to the attached image) or a simpler version that references the style guide once it's complete? issue

Looking forward to hearing your thoughts!

kadenzipfel commented 1 month ago

@rakesh0x7, PR template looks great. Feel free to make a pull request to add it.

As for the issue template, I don't think issues need to be formatted super well, maybe instead it could have the user check a checkbox indicating that they've checked to see if the issue or feature being added exists already then could maybe have a "type of change" checkbox section like the PR template and then maybe just a section to explain the issue. What do you think?

rakesh0x7 commented 1 month ago

@rakesh0x7, PR template looks great. Feel free to make a pull request to add it.

sure, thanks.

What do you think?

yeah, it's a good idea. I have created a sample issue template, could you please have a look

Screenshot from 2024-05-21 22-20-01

It will looks like this when someone clicks on new issue Screenshot from 2024-05-21 22-20-15

Looking forward to hearing your thoughts!

kadenzipfel commented 1 month ago

@rakesh0x7, looks good! Feel free to submit a PR

rakesh0x7 commented 1 month ago

@kadenzipfel, Thanks for confirming. Could you please assign it to me