search

fabian-hiller / valibot

The modular and type safe schema library for validating structural data 🤖
https://valibot.dev
MIT License
6.13k stars 195 forks source link

[feat]: Request for PR and Issue Templates #95

Open dev-phantom opened 1 year ago

dev-phantom commented 1 year ago

I'd like to request the implementation of Pull Request (PR) and Issue templates for our repository. These templates would help streamline collaboration and communication by providing consistent guidelines and structures.

Pull Request (PR) Templates: Having a PR template in place would ensure that contributors include essential details when submitting code changes. The template could include sections for describing the changes, providing an overview, linking related issues, and listing testing steps.

Issue Templates: Issue templates would guide contributors to provide necessary information when creating new issues. This could include predefined categories like bug reports, feature requests, and enhancements, each with relevant fields to capture important context.

Benefits:

  1. Consistency: Templates would standardize information, reducing confusion for both contributors and maintainers.
  2. Efficiency: Clear information would enhance code reviews and issue triaging.
  3. User-Friendly: Contributors, especially new ones, would find it easier to follow the guidelines.

Proposed Implementation: To implement these templates, we can leverage GitHub's built-in feature for custom templates. Markdown files would be added to the .github directory in the repository.

fabian-hiller commented 1 year ago

Good idea! Do you want to create a first draft and submit a PR?

dev-phantom commented 1 year ago

Good idea! Do you want to create a first draft and submit a PR?

I'd love to 😊🚀