Skip to content

Commit

Permalink
Create pull_request_template.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
VikramxD authored Dec 25, 2024
1 parent 08f2aef commit 0b886d7
Showing 1 changed file with 80 additions and 0 deletions.
80 changes: 80 additions & 0 deletions .github/pull_request_template.md.
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Pull Request Template for MinMochi

## Description

### What does this PR do?

- [ ] Adds new functionality
- [ ] Fixes a bug
- [ ] Updates documentation
- [ ] Improves performance
- [ ] Refactors code

Please provide a detailed description of what this PR accomplishes and why the changes were made.

---

## Related Issue

<!-- If applicable, link the issue this PR addresses -->
Fixes #<issue-number>

---

## Changes Summary

### Key Changes:
1. **Feature/Component Name**:
- Short description of change(s).
2. **Feature/Component Name**:
- Short description of change(s).

### Added Dependencies:
- List any new dependencies (from `requirements.txt` or `pyproject.toml`) and their purpose.

---

## Testing

### Unit Tests:
- [ ] Added/Updated unit tests.
- [ ] Tested locally using specific test cases.

### Steps to Test:
1. Describe how reviewers can test this PR.
2. Include any relevant sample payloads or commands.

### Expected Behavior:
- Describe the expected outcome of the changes.

---

## Checklist

- [ ] Code is clean and adheres to project conventions.
- [ ] Updated relevant documentation (README, comments, etc.).
- [ ] Ran `pylint`, `black`, or equivalent formatting tools.
- [ ] Confirmed backward compatibility.

---

## Metrics and Monitoring

### Prometheus:
- Added/Updated metrics:
- Metric name: `<metric_name>` (e.g., `request_processing_time`)
- Description: `<description>`

### Logging:
- [ ] Logs are structured with `loguru`.
- [ ] Verified logging covers edge cases.

---

## Additional Information

- Notes for the reviewer:
- Special considerations (e.g., large changes, experimental features).
- Assumptions made in this implementation.

---

0 comments on commit 0b886d7

Please sign in to comment.