bolicos / fictional-goggles

MIT License
0 stars 1 forks source link
example-project hacktoberfest javascript testing typescript

Hacktoberfest Contribution: Pull Request/Merge Request Templates

πŸ“ Description

Provide a clear and concise description of what this MR/PR addresses. Include the following:

Example:

This PR addresses issue #123 by adding a new feature that allows users to filter dragons by species on the dashboard. It improves user experience by providing more specific search results.

πŸ›  Changes Made

List the changes this pull request mades. Ensure they are clear and relevant to the task or issue you are addressing. Try to use a prefix to inform the changes

Example:


πŸ“Έ Screenshots (if applicable)

If the changes affect the user interface or generate visible output, provide before and after screenshots to help reviewers understand the visual impact.

Example:

![Before and After Screenshots](link_to_screenshot)

πŸ“‹ Checklist

Ensure all the steps below are checked before submitting. This helps maintain the quality and integrity of the codebase.


πŸ§ͺ Testing Instructions

Provide instructions for testing your changes. Include detailed steps for setting up the environment, running the application, and testing the new feature or bug fix.

Example:

  1. Pull the branch to your local machine.
  2. Run the application locally (npm start or equivalent).
  3. Open localhost:3000 and navigate to the dragons dashboard.
  4. Use the filter by species dropdown and verify the correct dragons are displayed.
  5. Run unit tests using npm test to ensure the feature is properly tested.

πŸ”— Related Issues/PRs

Link any related issues or merge requests that provide additional context or are connected to this change.

Example:

Closes #123
Depends on PR #456

πŸ™Œ Hacktoberfest Checklist


πŸ‘€ Additional Comments

Add any additional comments, questions, or notes for the maintainers or reviewers. This could include:


Feel free to customize this template to suit the project's specific needs!