Skip to content

docs: fix contributor test instructions and SPEC heading table #162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MuhammadHasbiAshshiddieqy wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −6
Open

docs: fix contributor test instructions and SPEC heading table #162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ To get started contributing:
1. Fork the repo, develop and test your code changes.
1. Ensure that your code adheres to the existing style.
1. Ensure that your code has an appropriate set of unit tests which all pass.
1. Ensure that all tests pass (e.g., by running `npm run test` in the TypeScript package directories).
1. Ensure that all tests pass for the package(s) you touched:
- Python packages (e.g. `okf/`): `pip install -e ".[dev]"` then `pytest`.
- TypeScript packages that define a `test` script (e.g. `toolbox/mdcode`): `npm run test`.
1. Submit a pull request.

## Contributor License Agreement
Expand Down
12 changes: 7 additions & 5 deletions okf/SPEC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,11 +170,13 @@ prose, since structure aids both human reading and agent retrieval.
There are no required body sections. The following section headings have
**conventional** meaning and SHOULD be used when applicable:

| Heading | Purpose |
|----------------|--------------------------------------------------------|
| `# Schema` | Structured description of an asset's columns/fields. |
| `# Examples` | Concrete usage examples, often as fenced code blocks. |
| `# Citations` | External sources backing claims in the body. See §8. |
| Heading | Purpose |
|--------------------------|--------------------------------------------------------|
| `# Schema` | Structured description of an asset's columns/fields. |
| `# Examples` | Concrete usage examples, often as fenced code blocks. |
| `# Common query patterns`| Representative queries against the asset, fenced as code. |
| `# Joins` | How this asset relates to or joins with others. |
| `# Citations` | External sources backing claims in the body. See §8. |

### 4.3 Example: a concept bound to a resource

Expand Down