Skip to content

Commit

Permalink
Fix MdFormat (#1520)
Browse files Browse the repository at this point in the history
  • Loading branch information
collindutter authored Jan 8, 2025
1 parent 446df15 commit bc148b5
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 26 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/preapproved.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Pre-Discussed and Approved Topics
about: Only for topics already discussed and approved in the GitHub Discussions section.
name: Pre-Discussed and Approved Topics
about: Only for topics already discussed and approved in the GitHub Discussions section.
---

Is this a reproducible bug? If not, please open a new [Github Discussion](https://github.com/orgs/griptape-ai/discussions/new/choose).
24 changes: 5 additions & 19 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,15 @@ repos:
args: [--py39-plus, --keep-runtime-typing]
- repo: local
hooks:
- id: ruff-lint
name: Ruff
entry: make lint
language: system
types: [python]
- repo: local
hooks:
- id: ruff-format
name: Ruff
- id: format
name: Format
entry: make format
language: system
types: [python]
- repo: local
hooks:
- id: pyright
name: Pyright
entry: make check/types
language: system
types: [python]
- repo: local
hooks:
- id: typos
name: Typos
entry: make check/spell
- id: types
name: Check
entry: make check
language: system
types: [python]
10 changes: 6 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ friendly to new contributors are tagged with "good first issue".
**I have a bug!**

1. Search the issue tracker and discussions for similar issues.
2. If you don't have steps to reproduce, open a discussion.
3. If you have steps to reproduce, open an issue.
1. If you don't have steps to reproduce, open a discussion.
1. If you have steps to reproduce, open an issue.

**I have an idea for a feature!**

Expand All @@ -26,7 +26,7 @@ friendly to new contributors are tagged with "good first issue".
**I've implemented a feature!**

1. If there is an issue for the feature, open a pull request.
2. If there is no issue, open a discussion and link to your branch.
1. If there is no issue, open a discussion and link to your branch.

**I have a question!**

Expand Down Expand Up @@ -58,7 +58,6 @@ Pull requests should be associated with a previously accepted issue.
**If you open a pull request for something that wasn't previously discussed,**
it may be closed or remain stale for an indefinite period of time.


> [!NOTE]
>
> **Pull requests are NOT a place to discuss feature design.** Please do
Expand All @@ -75,16 +74,19 @@ The [Griptape Extension Template](https://github.com/griptape-ai/griptape-extens
## Dev Environment

Install all dependencies via Make:

```shell
make install
```

Run tests:

```shell
make test/unit
```

Run checks:

```shell
make check
```
Expand Down
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,15 @@ lint: ## Lint project.
.PHONY: format
format: ## Format project.
@poetry run ruff format
@poetry run mdformat .
@poetry run mdformat .github/ docs/

.PHONY: check
check: check/format check/lint check/types check/spell ## Run all checks.

.PHONY: check/format
check/format:
@poetry run ruff format --check
@poetry run mdformat --check .github/ docs/

.PHONY: check/lint
check/lint:
Expand Down

0 comments on commit bc148b5

Please sign in to comment.