Skip to content

bolicos/fictional-goggles

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hacktoberfest Contribution: Pull Request/Merge Request Templates

📝 Description

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

  • What issue, bug, or feature does this solve or add?
  • Any specific motivation or context behind the contribution.
  • Link to any related issues (if applicable).

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:

  • Feat -> Add filtering flow for the DragonController.
  • Feat -> Implement the filter by species method in the service layer.
  • Tests -> Create unit tests for the filtering feature.
  • Doc -> Updated API documentation to include the new filtering query parameter.
  • Fix -> Solve an issue with filter by species method.

📸 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.

  • Code compiles without errors.
  • All new and existing tests pass.
  • Code follows project style guidelines.
  • There are no merge conflicts.
  • Documentation has been updated (if needed).
  • New tests have been added to cover the changes.

🧪 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

  • This pull request adheres to the Hacktoberfest contribution guidelines.
  • The change is relevant and valuable to the project.
  • The PR is in line with the Hacktoberfest quality standards.
  • I have read and agree to the project’s contribution guidelines.

👀 Additional Comments

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

  • Known issues with the feature or code.
  • Suggested improvements for future iterations.
  • Clarifications you need from the maintainers.

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

About

No description or website provided.

Topics

Resources

License

Code of conduct

Stars

0 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors