wehub-resource-sync
83 lines
2.4 KiB
Markdown
83 lines
2.4 KiB
Markdown
## Summary
|
||
|
||
> 🎯 **Purpose**: Describe the objective of your changes in this Pull-Request.
|
||
>
|
||
> 📜 **Example Usage**: If adding new functionality, strive to provide a minimal working example (MWE) that demonstrates end-to-end usage and output of your new methods. If creating a MWE is not feasible, a conceptual code snippet showcasing the usage is also appreciated. Ensure that the code provided can be copied, pasted, and run without modifications.
|
||
|
||
**[ ✏️ Write your summary here. ]**
|
||
|
||
```python
|
||
# Example code snippet
|
||
|
||
# Necessary Imports:
|
||
from my_module import my_new_function
|
||
|
||
# Setup if needed (e.g., data loading, model instantiation):
|
||
a = 20
|
||
b = 22
|
||
|
||
# Usage and Output:
|
||
result = my_new_function(a, b)
|
||
# 42
|
||
|
||
# ---- Your code below ----
|
||
# [Replace the example above with your own code, ensuring it is executable and demonstrates your feature or fix.]
|
||
[your_uncommented_runnable_code_here]
|
||
# [your_output_here_as_a_comment]
|
||
```
|
||
|
||
## Impact
|
||
|
||
> 🌐 Areas Affected: Enumerate modules, functions, or documentation impacted by your code.
|
||
>
|
||
> 👥 Who’s Affected: Mention who might be impacted (if applicable).
|
||
|
||
**Screenshots**
|
||
|
||
> 📸 If your changes modify documentation or a tutorial notebook, please include screenshots or GIFs showing the rendered outputs for a quicker initial review, highlighting the main changes.
|
||
|
||
|
||
## Testing
|
||
|
||
> 🔍 Testing Done: Outline what kinds of tests you performed.
|
||
>
|
||
> 🔗 Test Case Link: Directly link to the most end-to-end check of your new functionality.
|
||
|
||
**Unaddressed Cases**
|
||
|
||
> It's ok if your unit tests are not yet
|
||
> comprehensive when you first open the PR,
|
||
> we can revisit them later!
|
||
>
|
||
> ⚠️ Mention any aspects of testing that have *not* been covered, and why.
|
||
|
||
-
|
||
|
||
## Links to Relevant Issues or Conversations
|
||
|
||
> 🔗 What Git or Slack items (Issues, threads, etc) that are specifically related to
|
||
> this work? Please link them here.
|
||
|
||
-
|
||
|
||
## References
|
||
|
||
> 📚 Include any extra information that may be helpful to reviewers of your
|
||
> Pull-Request here (e.g. relevant URLs or Wiki pages that could help give
|
||
> background information).
|
||
>
|
||
> Share links, docs, or sources that facilitated your changes.
|
||
>
|
||
> If relevant, please include additional code snippets
|
||
> (and their outputs/return values) showing alternative ways to use your newly added methods.
|
||
|
||
```python
|
||
[additional code snippets and explanations]
|
||
```
|
||
|
||
-
|
||
|
||
## Reviewer Notes
|
||
> 💡 Include any specific points for the reviewer to consider during their review.
|
||
|