Skip to content
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
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
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?

30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ We've provided a list of community-driven content below. When adding content to
- [Recurring Events](#content-recurring-event)
- [Upcoming Events](#content-upcoming_event)
- [The OCaml Changelog](#content-changelog)
- [PR Template](#content-cookbook)
Copy link
Collaborator

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. 👍


The following sections give more details on how to contribute to each.

Expand Down Expand Up @@ -179,6 +180,7 @@ The Changelog covers developments across:
- [OCaml Infrastructure](https://infra.ocaml.org/)
- [OCaml.org itself](https://ocaml.org/)


#### Purpose and Audience

The primary audience for the Changelog is OCaml users. Content should focus on changes, updates, and news that directly impact users of OCaml and its ecosystem.
Expand Down Expand Up @@ -207,6 +209,34 @@ To contribute a new post to the Changelog:
4. Write the post content, focusing on how the news or change affects OCaml users.
5. Submit a pull request with your new file.

### <a name="content-cookbook"></a>OCaml Cookbook Recipe Review Checklist

#### Guidelines for New Recipes

When contributing new recipes to the OCaml Cookbook, please adhere to the following:

1. **Task Selection**:
- Focus on practical, reusable tasks relevant to a wide audience.
- Ensure the task demonstrates idiomatic OCaml usage.
- Avoid tasks that are overly trivial or highly specific to niche cases.

2. **Code Standards**:
- Write clear, idiomatic OCaml code.
- Ensure the code compiles without errors or warnings.
- Use standard OCaml libraries and tools wherever possible.

3. **Evaluation Criteria**:
- Does the recipe address a useful real-world task?
- Is the code ready for production use?
- If using a package, does it implicitly recommend the package for production?
- Avoid duplicating existing recipes unless demonstrating package differences.

4. **Submission Process**:
- Link your PR to the relevant issue or discussion thread.
- Use the provided PR template to ensure all guidelines are met.

Following these guidelines will help us maintain a high-quality and consistent OCaml Cookbook.

## Git and GitHub Workflow

The preferred workflow for contributing to a repository is to fork the main repository on GitHub, clone, and develop on a new branch.
Expand Down