This repository has been archived by the owner on Jan 16, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 138
Add Quick Start to Readme #236
Draft
ai-yann
wants to merge
2
commits into
main
Choose a base branch
from
test-pr
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.
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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 was deleted.
Oops, something went wrong.
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,51 @@ | ||
| # Pull Request | ||
|
|
||
| ## Type of Change | ||
| Please select one: | ||
| - [ ] New notebook | ||
| - [ ] Notebook update | ||
| - [ ] Documentation update | ||
| - [ ] Environment/dependency update | ||
| - [ ] Other | ||
|
|
||
| ## Description | ||
| [What changes does this PR make?] | ||
|
|
||
| ## Testing | ||
| [Describe how you've verified these changes work] | ||
|
|
||
| ### For Notebooks: | ||
| - Include a screen recording showing execution and outputs | ||
| - Or include screenshots of key outputs with explanation | ||
|
|
||
| ### For Documentation: | ||
| - Preview any markdown changes | ||
| - Test any new links or references | ||
|
|
||
| ## Notebook Changes Checklist | ||
| Complete if modifying notebooks: | ||
| - [ ] I have run the notebook from start to finish without errors | ||
| - [ ] I have cleared all cell outputs before committing | ||
| - [ ] I have included all required pip installations with pinned versions (e.g., pip install package==1.2.3) in %%sh cells at the start of the notebook | ||
| - [ ] I have included a screen recording or screenshots demonstrating the changes | ||
| - [ ] I have added sufficient markdown cells to explain the notebook's purpose and usage | ||
|
|
||
| ## Documentation Changes Checklist | ||
| Complete if modifying documentation: | ||
| - [ ] I have checked for similar wording/style issues across all documentation | ||
| - [ ] I have verified all links and references still work | ||
| - [ ] I have previewed how the changes will appear | ||
| - [ ] I have followed the repository's documentation style guide (if applicable) | ||
|
|
||
| ## Related Issues | ||
| [Add any related issue numbers (e.g., Fixes #123)] | ||
|
|
||
| --- | ||
|
|
||
| > **Note for notebook submissions:** | ||
| > - Run the notebook in a fresh environment (e.g., new conda env or colab instance) to ensure all dependencies are captured | ||
| > - Comments should explain the purpose of non-obvious code blocks and any external data dependencies | ||
|
|
||
| > **Note for documentation updates:** | ||
| > - For minor changes, consider bundling multiple related improvements in one PR | ||
| > - Look for opportunities to improve similar sections across the documentation |
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.
to add both options - v1 and v2, with v2 as the preferred one.