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

Contributing and code of conduct #815

Closed
wants to merge 4 commits into from

Conversation

mcandeia
Copy link
Contributor

@mcandeia mcandeia commented Aug 29, 2024

Pull Request: Improve Contribution Template for Better Issue Tracking and Review Process

Overview

This pull request aims to enhance the current contribution template by adding a section that requires contributors to link the relevant issue that their pull request addresses. Additionally, the template has been improved to encourage contributors to provide a Loom video for a clearer explanation of their changes and a demonstration link to help reviewers test the changes more easily.

Proposed Changes

  1. Issue Link Section:

    • Contributors are now required to link the relevant issue in their pull request. This will help maintainers and the community track which issues are being addressed and ensure that contributions are properly aligned with project goals.
    • Example:
      ## Issue Link
      Please link to the relevant issue that this pull request addresses:
      
      - Issue: [#ISSUE_NUMBER](link_to_issue)
  2. Loom Video Encouragement:

    • Contributors are encouraged to record a quick screencast using Loom to describe their changes. This will assist reviewers in understanding the context and functionality of the contribution.
  3. Demonstration Link:

    • Contributors are asked to provide a link to a branch or environment where their changes can be tested. This will streamline the review process by allowing maintainers to easily verify the contribution.

New Template Example

<!-- deno-fmt-ignore-file -->
## What is this Contribution About?

Please provide a brief description of the changes or enhancements you are proposing in this pull request.

## Issue Link

Please link to the relevant issue that this pull request addresses:

- Issue: [#ISSUE_NUMBER](link_to_issue)

## Loom Video

> Record a quick screencast describing your changes to help the team understand and review your contribution. This will greatly assist in the review process.

## Demonstration Link

> Provide a link to a branch or environment where this pull request can be tested and seen in action.

@mcandeia mcandeia force-pushed the contributing-and-code-of-conduct branch from 865f5c8 to 67befed Compare August 29, 2024 17:19
Signed-off-by: Marcos Candeia <[email protected]>
Signed-off-by: Marcos Candeia <[email protected]>
Signed-off-by: Marcos Candeia <[email protected]>
Signed-off-by: Marcos Candeia <[email protected]>
@mcandeia mcandeia force-pushed the contributing-and-code-of-conduct branch from 0c63e6d to 8539ba4 Compare August 29, 2024 17:30
@mcandeia mcandeia closed this Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant