You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As we are working towards developing the third edition of the DISCOVER Cookbook, we want to write a template for contributing or writing new chapters to the DISCOVER Cookbook, this is to ensure consistency and ease of contribution.
Hi, I’d love to contribute to this issue! Could you provide any specific format or guidelines you'd like the template to follow? Should it include sections for code examples, figures, or references? Looking forward to your guidance!
Hi! I see that this issue is about creating a standardized template for cookbook chapters.
I’d love to contribute by refining the existing template with better markdown formatting, clearer section definitions, and any additional improvements that may be needed.
Let me know if I can proceed with these enhancements.
Hi @aterrel , @melissawm ,
Could you please take a look and let me know if it aligns with your expectations or if there are any changes you'd suggest? I'm happy to make any adjustments needed. Thanks!
✅ PR Checklist for DISCOVER Cookbook Contributions
Before submitting your Pull Request (PR), please confirm that you've completed the following:
Contribution Type
Content addition or chapter update
Design improvement or accessibility fix
Documentation update (README, CONTRIBUTING, etc.)
Bug fix (non-content)
Other (please describe): ___________________________
To pick up a draggable item, press the space bar.
While dragging, use the arrow keys to move the item.
Press space again to drop the item in its new position, or press escape to cancel.
Idea Approval
I started with a discussion on the Discussions tab and received community or maintainer approval.
An issue was created and approved before this PR (link it below).
Issue reference: #______
To pick up a draggable item, press the space bar.
While dragging, use the arrow keys to move the item.
Press space again to drop the item in its new position, or press escape to cancel.
To pick up a draggable item, press the space bar.
While dragging, use the arrow keys to move the item.
Press space again to drop the item in its new position, or press escape to cancel.
Local Development
I have cloned the repo and created a new feature branch.
I built the book locally using the build instructions and verified the changes.
To pick up a draggable item, press the space bar.
While dragging, use the arrow keys to move the item.
Press space again to drop the item in its new position, or press escape to cancel.
Pre-Submission Tasks
I have written clear, concise commit messages using the conventional format outlined in CONTRIBUTING.md.
My PR includes necessary references, links to resources, or related discussions.
To pick up a draggable item, press the space bar.
While dragging, use the arrow keys to move the item.
Press space again to drop the item in its new position, or press escape to cancel.
Activity
Likith-Yadav commentedon Mar 28, 2025
Hi, I’d love to contribute to this issue! Could you provide any specific format or guidelines you'd like the template to follow? Should it include sections for code examples, figures, or references? Looking forward to your guidance!
Likith-Yadav commentedon Mar 28, 2025
okay , i have understood and here is a basic template that i have analysed so far
Chapter Title
1. Introduction
2. Learning Objectives
3. Prerequisites
4. Step-by-Step Implementation
This is a basic template I have analyzed so far. Let me know if any modifications or additional sections are needed!
ghost commentedon Apr 4, 2025
Hi! I see that this issue is about creating a standardized template for cookbook chapters.
I’d love to contribute by refining the existing template with better markdown formatting, clearer section definitions, and any additional improvements that may be needed.
Let me know if I can proceed with these enhancements.
ChehakTrehan commentedon May 23, 2025
Hii @seunolufemi123 please review my PR. I created the templated.
Thanks
Chehak
AR21SM commentedon May 27, 2025
Hi @aterrel , @melissawm ,
Could you please take a look and let me know if it aligns with your expectations or if there are any changes you'd suggest? I'm happy to make any adjustments needed. Thanks!
✅ PR Checklist for DISCOVER Cookbook Contributions
Before submitting your Pull Request (PR), please confirm that you've completed the following:
Contribution Type
___________________________
Idea Approval
I started with a discussion on the Discussions tab and received community or maintainer approval.
An issue was created and approved before this PR (link it below).
#______
Local Development
Pre-Submission Tasks
📝 Description of the Pull Request
aterrel commentedon May 27, 2025
@AR21SM yes that is fine are you wanting to make a template for PRs?
I know this issue was more on the lines of, "How do I write a chapter". There isn't a formal template for either but this seems reasonable for PRs.
AR21SM commentedon May 27, 2025
I think we can make two of them , one for PR review and one for writing chapters(focused on structure: Tittle, Content objectives ,references etc )
Give me some time , I’ll work on it and create a PR soon