notebooks Documentation

File: CONTRIBUTING.md Copy Chapter

🦸 Contributing to Roboflow Notebooks Copy Chapter

We love your input! We want to make contributing to Roboflow Notebooks as easy and transparent as possible, whether it's:

• Reporting a bug
• Discussing the current state of the code
• Submitting a fix
• Proposing a new feature
• Becoming a maintainer

🛠️ Submitting a Pull Request (PR) Copy Chapter

• Add new notebook .ipynb file to notebooks directory.
• Add new entry to automation/notebooks-table-data.csv file.
• Run automation/autogenerate_notebooks_table.py script. Roboflow Notebooks table in README.md will update
  automatically.
• Commit changes to feature branch. Create PR.

© License Copy Chapter

By contributing, you agree that your contributions will be licensed under the MIT license.

File: automation/README.md Copy Chapter

Don't change Roboflow Notebooks list in README.md manually! Copy Chapter

1. Add new notebook file .ipynb to notebooks directory.
2. Add new entry to automation/notebooks-table-data.csv file.
3. Run automation/autogenerate_notebooks_table.py script. Roboflow Notebooks table in README.md will update
   automatically.

python3 automation/autogenerate_notebooks_table.py

4. Commit changes to feature branch. Create PR.

File: .github/ISSUE_TEMPLATE/bug-report.yml Copy Chapter

name: 🐞 Bug Report

title: " "

labels: [bug, triage]
body:

• type: markdown
  attributes:
  value: |
  Thank you for submitting a Roboflow Notebooks 🐞 Bug Report!

• type: checkboxes
  attributes:
  label: Search before asking
  Please search the issues to see if a similar bug report already exists.
  
  options:
  - label: >
  I have searched the Roboflow Notebooks issues and found no similar bug report.
  required: true

• type: textarea
  attributes:
  label: Notebook name
  placeholder: |
  💡 ProTip! Provide link or name to Notebook that you are referring to.
  
  validations:
  required: true

• type: textarea
  attributes:
  label: Bug
  placeholder: |
  💡 ProTip! Include as much information as possible (screenshots, logs, tracebacks etc.) to receive the most helpful response.
  
  validations:
  required: true

• type: textarea
  attributes:
  label: Environment
  placeholder: |
  - Google Colab / Kaggle / Local
  - OS: Ubuntu 20.04
  - Python: 3.9.0
  
  validations:
  required: true

• type: textarea
  attributes:
  label: Minimal Reproducible Example
  When asking a question, people will be better able to provide help if you provide code that they can easily understand and use to reproduce the problem.
  This is referred to by community members as creating a minimal reproducible example.
  
  placeholder: |
  # Code to reproduce your issue here
  
  validations:
  required: false

• type: textarea
  attributes:
  label: Additional

• type: checkboxes
  attributes:
  label: Are you willing to submit a PR?
  (Optional) We encourage you to submit a Pull Request (PR) to help improve Roboflow Notebooks for everyone, especially if you have a good understanding of how to implement a fix or feature.
  See the Roboflow Notebooks Contributing Guide to get started.
  
  options:
  - label: Yes I'd like to help by submitting a PR!

File: .github/ISSUE_TEMPLATE/feature-request.yml Copy Chapter

name: 🚀 Feature Request

title: " "

labels: [enhancement]
body:

• type: markdown
  attributes:
  value: |
  Thank you for submitting a Roboflow Notebooks 🚀 Feature Request!

• type: checkboxes
  attributes:
  label: Search before asking
  Please search the issues to see if a similar bug report already exists.
  
  options:
  - label: >
  I have searched the Roboflow Notebooks issues and found no similar bug report.
  required: true

• type: textarea
  attributes:
  label: Description
  placeholder: |
  What tutorial do you think we should add to Roboflow Notebooks?
  
  validations:
  required: true

• type: textarea
  attributes:
  label: Additional

• type: checkboxes
  attributes:
  label: Are you willing to submit a PR?
  (Optional) We encourage you to submit a Pull Request (PR) to help improve Roboflow Notebooks for everyone, especially if you have a good understanding of how to implement a fix or feature.
  See the Roboflow Notebooks Contributing Guide to get started.
  
  options:
  - label: Yes I'd like to help by submitting a PR!

File: .github/workflows/issue-greetings.yml Copy Chapter

name: Issue greetings

on: [issues]

jobs:
greeting:
runs-on: ubuntu-latest
steps:
- uses: actions/first-interaction@v1
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
issue-message: |
👋 Hello @${{ github.actor }}, thank you for leaving an issue on Roboflow Notebooks.

## 🐞 Bug reports

        If you are filing a bug report, please be as detailed as possible. This will help us more easily diagnose and resolve the problem you are facing. To learn more about contributing, check out our [Contributing Guidelines](https://github.com/roboflow/notebooks/blob/main/CONTRIBUTING.md).

        If you require support with custom code that is not part of Roboflow Notebooks, please reach out on the [Roboflow Forum](https://discuss.roboflow.com) or on the [GitHub Discussions page](https://github.com/roboflow/notebooks/discussions) associated with this repository.

        ## 💬 Get in touch

        Do you have more questions about Roboflow that we haven't responded to yet? Feel free to ask them on the [Roboflow Discuss](https://discuss.roboflow.com) forum. Our developer advocates and community team actively respond to questions there.

        To ask questions about Notebooks, head over to the [GitHub Discussions](https://github.com/roboflow/notebooks/discussions) section of this repository.

File: .github/workflows/rebuild-readme-notebooks-table-on-pr-merge-to-main.yml Copy Chapter

name: rebuild readme.md notebooks table on pr merge to main
on:
push:
branches:
- main
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
ref: ${{ github.head_ref }}
- uses: actions/setup-python@v4
with:
python-version: 3.9
- name: Rebuild notebooks table in project README.md
run: python automation/autogenerate_notebooks_table.py
- name: Check for modified files
id: git-check
run: echo ::set-output name=modified::$(if [ -n "$(git status --porcelain)" ]; then echo "true"; else echo "false"; fi)
- name: Update changes in GitHub repository
if: steps.git-check.outputs.modified == 'true'
run: |
git config --global user.name 'SkalskiP'
git config --global user.email '[email protected]'
git commit -am "🤖 hello friend, the notebooks table has been rebuilt"
git push