-
-
Notifications
You must be signed in to change notification settings - Fork 1
Basic project scaffolding #1
Changes from all commits
7a7ba95
fbe68f0
e1d7f05
132bbd3
fb6c588
51078a3
67347a8
3d02fa9
44395e8
0f2a450
265c2fa
4cce386
002d368
929da12
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| <!--- Provide a general summary of your changes in the Title above --> | ||
|
|
||
| ## Description | ||
| <!--- Describe your changes in detail --> | ||
|
|
||
| ## Motivation and Context | ||
| <!--- Why is this change required? What problem does it solve? --> | ||
| <!--- If it fixes an open issue, please link to the issue here. --> | ||
| <!--- If there's a Figma file or similar spec, please link to to the issue. --> | ||
|
|
||
| ## Screenshots (if appropriate): | ||
|
|
||
| ## Types of changes | ||
| <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> | ||
| - [ ] Bug fix (non-breaking change which fixes an issue) | ||
| - [ ] New feature (non-breaking change which adds functionality) | ||
| - [ ] Breaking change (fix or feature that would cause existing functionality to change) | ||
|
|
||
| ## Checklist: | ||
| <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> | ||
| <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> | ||
| - [ ] I've checked the spec (e.g. Figma file) and documented any divergences. | ||
| - [ ] My code follows the code style of this project. | ||
| - [ ] My code follows the code style of this project. | ||
| - [ ] My change requires a change to the documentation. | ||
| - [ ] I've updated the documentation accordingly. | ||
| - [ ] Replace unused checkboxes with bullet points. | ||
|
Comment on lines
+1
to
+27
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This template is inherited by the org-wide settings, so we don't need to include it in this repo. Duplicating it means we can craft it to fit this package's context better, but we lose automatic improvements from the upstream version. If we do duplicate, we could probably improve it by cutting line 24 (which is a duplicate!) This should also be fixed in the org-wide version...
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't feel that the org-wide settings need changing – they look pretty good to me, although sure they'll evolve as we use them more. Just felt that a library has slightly different requirements for a PR than an application. They change a bit more in the forthcoming contributor guidelines PR. |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| name: merge-to-main | ||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| jobs: | ||
| write-docs: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - uses: actions/setup-python@v2 | ||
| with: | ||
| python-version: 3.9 | ||
| - uses: Gr1N/setup-poetry@v7 | ||
| - uses: actions/cache@v2 | ||
| with: | ||
| path: ~/.cache/pypoetry/virtualenvs | ||
| key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }} | ||
| - run: make bootstrap | ||
| - run: make deploy-docs |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| name: pull-request | ||
| on: | ||
| pull_request: | ||
| branches: | ||
| - main | ||
| jobs: | ||
| tests: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - uses: actions/setup-python@v2 | ||
| with: | ||
| python-version: 3.9 | ||
| - uses: Gr1N/setup-poetry@v7 | ||
| - uses: actions/cache@v2 | ||
| with: | ||
| path: ~/.cache/pypoetry/virtualenvs | ||
| key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }} | ||
| - run: make bootstrap | ||
| - run: make deploy-docs |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -127,3 +127,4 @@ dmypy.json | |
|
|
||
| # Pyre type checker | ||
| .pyre/ | ||
| node_modules | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| default_language_version: | ||
| python: python3.9 | ||
|
|
||
| default_stages: [commit, push] | ||
|
|
||
| repos: | ||
| - repo: https://github.com/pre-commit/pre-commit-hooks | ||
| rev: v2.5.0 | ||
| hooks: | ||
| # YAML code formatter | ||
| - id: check-yaml | ||
| # Enforce EOF newlines | ||
| - id: end-of-file-fixer | ||
| exclude: LICENSE | ||
|
|
||
| - repo: local | ||
| hooks: | ||
| # Upgrade outdated python syntax | ||
| - id: pyupgrade | ||
| name: pyupgrade | ||
| entry: poetry run pyupgrade --py38-plus | ||
| types: [python] | ||
| language: system | ||
|
|
||
| - repo: local | ||
| hooks: | ||
| # Sort ordering of python imports | ||
| - id: isort | ||
| name: isort | ||
| entry: poetry run isort --settings-path pyproject.toml | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Very cool. As using
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yep! |
||
| types: [python] | ||
| language: system | ||
|
|
||
| - repo: local | ||
| hooks: | ||
| # Run code formatting on python code | ||
| - id: black | ||
| name: black | ||
| entry: poetry run black --config pyproject.toml | ||
| types: [python] | ||
| language: system | ||
Uh oh!
There was an error while loading. Please reload this page.