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:
- Pull the branch to your local machine.
- Run the application locally (
npm start
or equivalent).
- Open
localhost:3000
and navigate to the dragons dashboard.
- Use the filter by species dropdown and verify the correct dragons are displayed.
- 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!