Thank you for considering contributing to [App Name]! We welcome all types of contributions, including bug reports, feature requests, documentation improvements, and code enhancements.
name Nwanozie Promise
-
Follow the Code of Conduct: Please read and adhere to the Code of Conduct.
-
Style Guide: Ensure your code follows the project's coding style. This includes proper indentation, variable naming conventions, and inline comments where necessary.
-
Testing: Make sure your changes are well-tested. Write unit tests for new functionality and run all tests to ensure nothing is broken.
-
Documentation: Update or add documentation for any changes made. This includes comments in the code, updating README files, or any other relevant documentation.
-
Commit Messages: Write clear, concise commit messages that accurately describe the changes made.
-
Review Feedback: Be open to feedback and be ready to make additional changes to your PR based on the review.
[Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.]
Fixes # (issue) [Tag the issue number here]
[If applicable, list any new endpoints added or modified]
- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing functionality to not work as expected)
- This change requires a documentation update
- My code follows the style guidelines of this project
- I have performed a self-review of my own code
- I have commented my code, particularly in hard-to-understand areas
- I have made corresponding changes to the documentation
- My changes generate no new warnings
- I have added tests that prove my fix is effective or that my feature works
- New and existing unit tests pass locally with my changes
- Any dependent changes have been merged and published in downstream modules
Add any other context or screenshots about the pull request here.