search

webmeshproj / webmesh

A simple, distributed, zero-configuration WireGuard mesh solution
https://webmeshproj.github.io
Apache License 2.0
420 stars 16 forks source link

Create PULL_REQUEST_TEMPLATE.md #19

Closed emmygozi closed 9 months ago

emmygozi commented 9 months ago

Description:

This pull request introduces a PULL_REQUEST_TEMPLATE.md file to enhance the contribution process. The template is designed to streamline pull request submissions by guiding contributors through the necessary steps, ensuring that submissions are well-documented, properly formatted, and aligned with the project's guidelines.

The template includes prompts for essential information, such as:

A clear and descriptive title summarizing the changes A detailed description of the proposed changes Steps to test or verify the modifications Any relevant issue references or linked discussions This addition aims to improve collaboration by providing a structured framework for submitting contributions, enabling smoother code review processes, and ultimately enhancing the overall quality and consistency of contributions to the project.

My Experience: I have Javascript development experience but I am mainly a devOps engineer. I saw your post on Reddit about being open to working with engineers: https://www.reddit.com/r/golang/comments/15hpj98/open_source_go_and_devops_projects_to_contribute/

This contribution appears to be the lowest-hanging fruit I could make. Hopefully, there will be many more.

tinyzimmer commented 9 months ago

This is fantastic - thanks for doing the leg work!