mirror of
https://github.com/mikefarah/yq.git
synced 2026-07-04 03:15:39 +00:00
Include MD files in spell checker
This commit is contained in:
parent
034df5c91e
commit
3bbbfbf3b5
@ -11,7 +11,7 @@ appearance, race, religion, or sexual identity and orientation.
|
|||||||
|
|
||||||
## Our Standards
|
## Our Standards
|
||||||
|
|
||||||
Examples of behavior that contributes to creating a positive environment
|
Examples of behaviour that contributes to creating a positive environment
|
||||||
include:
|
include:
|
||||||
|
|
||||||
* Using welcoming and inclusive language
|
* Using welcoming and inclusive language
|
||||||
@ -20,7 +20,7 @@ include:
|
|||||||
* Focusing on what is best for the community
|
* Focusing on what is best for the community
|
||||||
* Showing empathy towards other community members
|
* Showing empathy towards other community members
|
||||||
|
|
||||||
Examples of unacceptable behavior by participants include:
|
Examples of unacceptable behaviour by participants include:
|
||||||
|
|
||||||
* The use of sexualized language or imagery and unwelcome sexual attention or
|
* The use of sexualized language or imagery and unwelcome sexual attention or
|
||||||
advances
|
advances
|
||||||
@ -34,13 +34,13 @@ Examples of unacceptable behavior by participants include:
|
|||||||
## Our Responsibilities
|
## Our Responsibilities
|
||||||
|
|
||||||
Project maintainers are responsible for clarifying the standards of acceptable
|
Project maintainers are responsible for clarifying the standards of acceptable
|
||||||
behavior and are expected to take appropriate and fair corrective action in
|
behaviour and are expected to take appropriate and fair corrective action in
|
||||||
response to any instances of unacceptable behavior.
|
response to any instances of unacceptable behaviour.
|
||||||
|
|
||||||
Project maintainers have the right and responsibility to remove, edit, or
|
Project maintainers have the right and responsibility to remove, edit, or
|
||||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||||
permanently any contributor for other behaviors that they deem inappropriate,
|
permanently any contributor for other behaviours that they deem inappropriate,
|
||||||
threatening, offensive, or harmful.
|
threatening, offensive, or harmful.
|
||||||
|
|
||||||
## Scope
|
## Scope
|
||||||
@ -54,7 +54,7 @@ further defined and clarified by project maintainers.
|
|||||||
|
|
||||||
## Enforcement
|
## Enforcement
|
||||||
|
|
||||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
Instances of abusive, harassing, or otherwise unacceptable behaviour may be
|
||||||
reported by contacting the project team at mikefarah@gmail.com. All
|
reported by contacting the project team at mikefarah@gmail.com. All
|
||||||
complaints will be reviewed and investigated and will result in a response that
|
complaints will be reviewed and investigated and will result in a response that
|
||||||
is deemed necessary and appropriate to the circumstances. The project team is
|
is deemed necessary and appropriate to the circumstances. The project team is
|
||||||
|
|||||||
10
agents.md
10
agents.md
@ -4,7 +4,7 @@
|
|||||||
- run ./scripts/format.sh to format the code; then ./scripts/check.sh lint and finally ./scripts/spelling.sh to check spelling.
|
- run ./scripts/format.sh to format the code; then ./scripts/check.sh lint and finally ./scripts/spelling.sh to check spelling.
|
||||||
- Add comprehensive tests to cover the changes
|
- Add comprehensive tests to cover the changes
|
||||||
- Run test suite to ensure there is no regression
|
- Run test suite to ensure there is no regression
|
||||||
- Use UK english spelling (e.g. Colorisation not Colorization)
|
- Use UK english spelling
|
||||||
|
|
||||||
❌ **DON'T:**
|
❌ **DON'T:**
|
||||||
- Git add or commit
|
- Git add or commit
|
||||||
@ -197,14 +197,6 @@ Tests must be implemented in `<format>_test.go` following the `formatScenario` p
|
|||||||
|
|
||||||
## Common Patterns
|
## Common Patterns
|
||||||
|
|
||||||
### Scalar-Only Formats
|
|
||||||
Some formats only work with scalars (like base64, uri):
|
|
||||||
```go
|
|
||||||
if node.guessTagFromCustomType() != "!!str" {
|
|
||||||
return fmt.Errorf("cannot encode %v as <format>, can only operate on strings", node.Tag)
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Format with Indentation
|
### Format with Indentation
|
||||||
Use preferences to control output formatting:
|
Use preferences to control output formatting:
|
||||||
```go
|
```go
|
||||||
|
|||||||
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Various operators for parsing and manipulating dates.
|
Various operators for parsing and manipulating dates.
|
||||||
|
|
||||||
## Date time formattings
|
## Date time formatting
|
||||||
This uses Golang's built in time library for parsing and formatting date times.
|
This uses Golang's built in time library for parsing and formatting date times.
|
||||||
|
|
||||||
When not specified, the RFC3339 standard is assumed `2006-01-02T15:04:05Z07:00` for parsing.
|
When not specified, the RFC3339 standard is assumed `2006-01-02T15:04:05Z07:00` for parsing.
|
||||||
|
|||||||
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Various operators for parsing and manipulating dates.
|
Various operators for parsing and manipulating dates.
|
||||||
|
|
||||||
## Date time formattings
|
## Date time formatting
|
||||||
This uses Golang's built in time library for parsing and formatting date times.
|
This uses Golang's built in time library for parsing and formatting date times.
|
||||||
|
|
||||||
When not specified, the RFC3339 standard is assumed `2006-01-02T15:04:05Z07:00` for parsing.
|
When not specified, the RFC3339 standard is assumed `2006-01-02T15:04:05Z07:00` for parsing.
|
||||||
|
|||||||
@ -278,3 +278,10 @@ zclconf
|
|||||||
cty
|
cty
|
||||||
go-cty
|
go-cty
|
||||||
Colorisation
|
Colorisation
|
||||||
|
goimports
|
||||||
|
errorlint
|
||||||
|
RDBMS
|
||||||
|
expeñded
|
||||||
|
bananabananabananabanana
|
||||||
|
edwinjhlee
|
||||||
|
flox
|
||||||
@ -1,3 +1,3 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
npx cspell --no-progress "**/*.{sh,go}"
|
npx cspell --no-progress "**/*.{sh,go,md}"
|
||||||
Loading…
Reference in New Issue
Block a user