-
Notifications
You must be signed in to change notification settings - Fork 333
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added PR template file in github. and added PR Template section in contributions.md file #2907
Open
labdhiongithub7
wants to merge
5
commits into
ocaml:main
Choose a base branch
from
labdhiongithub7:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
743be79
Update CONTRIBUTING.md PR Template Added
labdhiongithub7 ad2052c
Create PULL_REQUEST_TEMPLATE.md file added
labdhiongithub7 b65ac85
Update CONTRIBUTING.md added PR template section
labdhiongithub7 0ab1379
Merge branch 'ocaml:main' into main
labdhiongithub7 186c05e
Update CONTRIBUTING.md updated the OCml Cookbook Recipes Section
labdhiongithub7 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
## Pull Request Template for OCaml Cookbook Contributions | ||
|
||
#### Checklist | ||
Ensure the following are addressed before submitting your PR: | ||
|
||
1. **Real-World Usefulness**: | ||
- [ ] Does the task address a practical need in real-world application development? | ||
|
||
2. **Code Quality**: | ||
- [ ] Is the code production-ready, safe, and free of potential security issues? | ||
- [ ] Does the code avoid uncaught exceptions or other potential pitfalls? | ||
|
||
3. **Standard Library and Packages**: | ||
- [ ] For tasks using the Standard Library: Does this recipe provide value beyond what an LLM could easily generate? | ||
- [ ] For tasks using a package: Does this recipe implicitly recommend the package for production use? | ||
|
||
4. **Recipe Redundancy**: | ||
- [ ] Does this recipe duplicate an existing task? If so, does it add value by showing differences between packages or approaches? | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would recommend to put this under the existing "OCaml Cookbook Recipes" section, not as a separate section.
Overall looks useful to me. 👍