Merge pull request #52 from PrefectHQ/sync-with-template

Sync Collection with changes to prefect-collection-template
PrefectHQ · Nov 30, 2022 · d49a725 · d49a725
2 parents 180571b + efe58b0
commit d49a725
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 32 deletions.
diff --git a/.cruft.json b/.cruft.json
@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/PrefectHQ/prefect-collection-template",
-  "commit": "ff7c2498c022e0722e9ed99a09e7bc58d22b94d9",
+  "commit": "dabff0c99e3eb545d926ec6026bf8843e84eeb6a",
   "checkout": null,
   "context": {
     "cookiecutter": {

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,32 +1,28 @@
-<!-- 
-Thanks for opening a pull request to prefect-ray 🎉!
+<!-- Thanks for contributing 🎉! Please ensure the title neatly summarizes the proposed changes. -->
 
-We've got a few requests to help us review contributions:
+<!-- Overview -->
 
-- Make sure that your title neatly summarizes the proposed changes.
-- Provide a short overview of the change and the value it adds.
-- Share an example to help us understand the change in user experience.
-- Run `pre-commit install && pre-commit run --all` for linting.
-
-Happy engineering!
--->
-
-<!-- Include an overview here -->
-
-<!-- Link to issue -->
-Closes #
+Closes
 
 ### Example
-<!-- 
-Share an example of the change in action.
-
-A code blurb is best. Changes to features should include an example that is executable by a new user.
+<!-- A code blurb is best. Changes to features should include an example that is executable by a new user. -->
+
+### Screenshots
+<!--
+Any relevant screenshots
+  - The updated docs page from `mkdocs serve`.
+  - Output from running the example.
+  - Service integration test results.
 -->
 
 ### Checklist
 <!-- These boxes may be checked after opening the pull request. -->
 
-- [ ] This pull request references any related issue by including "Closes #<ISSUE_NUMBER>"
-	- If no issue exists and your change is not a small fix, please [create an issue](https://github.com/PrefectHQ/prefect-ray/issues/new/choose) first.
-- [ ] This pull request includes tests or only affects documentation.
-- [ ] Summarized PR's changes in [CHANGELOG.md](https://github.com/PrefectHQ/prefect-ray/blob/main/CHANGELOG.md)
+- [ ] References any related issue by including "Closes #<Issue Number>" or "Closes <Issue URL>".
+  - If no issue exists and your change is not a small fix, please [create an issue](https://github.com/PrefectHQ/prefect-ray/issues/new/choose) first.
+- [ ] Includes tests or only affects documentation.
+- [ ] Passes `pre-commit` checks.
+  - Run `pre-commit install && pre-commit run --all` locally for formatting and linting.
+- [ ] Includes screenshots of documentation updates.
+  - Run `mkdocs serve` view documentation locally.
+- [ ] Summarizes PR's changes in [CHANGELOG.md](https://github.com/PrefectHQ/prefect-ray/blob/main/CHANGELOG.md)
diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
@@ -17,7 +17,7 @@ jobs:
           python -m pip install --upgrade --upgrade-strategy eager -e .[dev]
           mkdocs build
       - name: Publish docs
-        uses: JamesIves/github-pages-deploy-action@v4.4.0
+        uses: JamesIves/github-pages-deploy-action@v4.4.1
         with:
           branch: docs
           folder: site
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -66,7 +66,7 @@ jobs:
           mkdocs build
 
       - name: Publish docs
-        uses: JamesIves/github-pages-deploy-action@v4.4.0
+        uses: JamesIves/github-pages-deploy-action@v4.4.1
         with:
           branch: docs
           folder: site
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -19,3 +19,11 @@ repos:
       - id: interrogate
         args: [-vv]
         pass_filenames: false
+  - repo: https://github.com/fsouza/autoflake8
+    rev: v0.3.2
+    hooks:
+      - id: autoflake8
+        language_version: python3
+        args: [
+          '--in-place',
+        ]
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -2,6 +2,8 @@
 
 ## Getting Started
 
+Now that you've bootstrapped a project, follow the steps below to get started developing your Prefect Collection!
+
 ### Python setup
 
 Requires an installation of Python 3.7+
@@ -10,10 +12,12 @@ We recommend using a Python virtual environment manager such as pipenv, conda or
 
 ### GitHub setup
 
-Generate a Prefect collection project in the terminal:
+Create a Git respoitory for the newly generated collection and create the first commit:
 
 ```bash
-cookiecutter https://github.com/PrefectHQ/prefect-collection-template
+git init
+git add .
+git commit -m "Initial commit: project generated by prefect-collection-template"
 ```
 
 Then, create a new repo following the prompts at:

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -35,16 +35,16 @@ plugins:
   - mkdocstrings:
       handlers:
         python:
-          rendering:
+          options:
             show_root_heading: True
             show_object_full_path: False
             show_category_heading: True
             show_bases: True
             show_signature: False
             heading_level: 1
-      watch:
-        - prefect_ray/
-        - README.md
+watch:
+    - prefect_ray/
+    - README.md
 
 nav:
     - Home: index.md