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
Copy file name to clipboardExpand all lines: examples/CONTRIBUTING.md
+12-12Lines changed: 12 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
-
# Contribution Guide
1
+
# Contribution guide
2
2
3
3
Thank you for contributing to our notebook examples! To ensure that your contribution aligns with our guidelines, please carefully review the following guide.
Review our [template notebook](template.ipynbs) for general overview on how notebooks should be structure. The template notebook and this section just serves as a guide and exceptions can be made. Here are our general requirements:
16
16
@@ -27,23 +27,23 @@ Review our [template notebook](template.ipynbs) for general overview on how note
27
27
> [!IMPORTANT]
28
28
> Please make sure to remove any API keys before pushing changes
29
29
30
-
## Branches and Tags
30
+
## Branches and tags
31
31
32
32
- All development happens in feature branches ideally prefixed by contributor's initials. For example `fs/feature_name`.
33
33
- Approved PRs are merged to the `develop` branch.
34
34
- All releases align to a git tag.
35
35
36
-
## Github Workflows
36
+
## Github workflows
37
37
38
38
- Github Branch Workflow
39
39
- When you push to a branch that contains files inside the examples directory, it will automatically reformat your notebook to match our given style and provide appropriate headers. Once this workflow is completed it will commit back to your branch which then you can pull.
40
40
- If your push contains new notebooks or modifies the names of notebooks the readme will be updated to reflect the change with updated links.
41
41
42
-
## General Prerequisites
42
+
## General prerequisites
43
43
44
44
[Rye](https://rye-up.com/) may be installed before contributing to the repository as it is the tool used to style our example notebooks. This could be used to avoid the github styling workflow. This is also the packaging tool used for the main SDK. The pyproject used for the example notebooks is a virtual package and does not get published.
45
45
46
-
## Styling Tools
46
+
## Styling tools
47
47
48
48
Rye is setup in this directory to use a customs script that will run the notebooks through our formatting tools and create readmes.
0 commit comments