Skip to content

Add Hikmat Abu Zayd knowledge and attribution files #1485

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.

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
42 changes: 42 additions & 0 deletions taxonomy/.github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: Bug/Problem report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

<!-- If you want to report a problem with the current model or taxonomy, please, fill out the following questionnaire. If the questionnaire doesn't match the type of problem you want to report, just delete the sections related to the model. -->

**Describe the bug/problem**

<!-- A concise description of what the problem is, replace "..." in the bullet list. -->

- ...
- ...
- ...

**Input given at the prompt**

<!-- What you entered, replace "..." -->

```
...
```

**Response that was received from the current model**

<!-- What you received from the current model in response to your input,
replace "..." -->

```
...
```

**Response that you expected instead**
<!-- What you expected to receive instead, replace "...". -->

```
...
```
40 changes: 40 additions & 0 deletions taxonomy/.github/ISSUE_TEMPLATE/proposal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Proposal
about: Create a contribution proposal
title: ''
labels: ''
assignees: ''

---

**Describe the proposed contribution to the taxonomy**

<!-- A concise description of what the proposed contribution would bring, replace "..." in the bullet list. -->

- ...
- ...
- ...

**Input given at the prompt**

<!-- What you entered, replace "..." -->

```
...
```

**Response from the current model**

<!-- What you received from the current model in response to your input,
replace "..." -->

```
...
```

**Response that you would expect instead with the contribution**
<!-- What you expect to receive instead with the finetuned model, replace "...". -->

```
...
```
21 changes: 21 additions & 0 deletions taxonomy/.github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# SPDX-License-Identifier: Apache-2.0

# GitHub Dependabot configuration file
version: 2
updates:

# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
- package-ecosystem: "docker"
directory: "/.github/workflows"
schedule:
interval: "daily"

# Maintain dependencies for Python scripts
- package-ecosystem: "pip"
directory: "/scripts"
schedule:
interval: "daily"
30 changes: 30 additions & 0 deletions taxonomy/.github/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# SPDX-License-Identifier: Apache-2.0

ci:
- changed-files:
- any-glob-to-any-file:
- scripts/**
- .github/workflows/**
- .github/*.yml

documentation:
- changed-files:
- any-glob-to-any-file:
- "*.md"
- docs/**

knowledge:
- changed-files:
- any-glob-to-any-file:
- knowledge/**

skill:
- changed-files:
- any-glob-to-any-file:
- compositional_skills/**

triage-needed:
- changed-files:
- any-glob-to-any-file:
- compositional_skills/**
- knowledge/**
57 changes: 57 additions & 0 deletions taxonomy/.github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
If your PR is related to a contribution to the taxonomy, please, fill
out the following questionnaire. If not, replace this whole text and the
following questionnaire with whatever information is applicable to your PR.


**Describe the contribution to the taxonomy**

<!-- A concise description of what the contribution brings, replace "..." in the bullet list -->

- ...
- ...
- ...


**Input given at the prompt**

<!-- What you entered, replace "..." -->

```
...
```


**Response from the original model**


<!-- What you received from the original model in response to your input,
replace "..." -->

```
...
```


**Response from the fine-tuned model**


<!-- Generate a synthetic dataset based on your newly added seed data; train the model
with the synthetic data and now re-test the model's response with the same prompt.
Replace "..." with what you receive with the finetuned model. -->

```
...
```

**Contribution checklist**

<!-- Insert an x between the empty brackets: [ ] >> [x] -->

- [ ] The contribution was tested with `ilab generate`
- [ ] No errors or warnings were produced by `ilab generate`
- [ ] All [commits are signed off](https://github.com/instructlab/taxonomy/blob/main/CONTRIBUTING.md#legal) (DCO)
- [ ] The `qna.yaml` file contains at least 5 `seed_examples`
- [ ] The `qna.yaml` file was [linted](https://yamllint.com) and [prettified](https://onlineyamltools.com/prettify-yaml) ([yaml-validator](https://jsonformatter.org/yaml-validator) can do both)
- [ ] An `attribution.txt` file in the same folder as the `qna.yaml` file
- [ ] Content does not include PII or otherwise sensitive or confidential information
- [ ] Content does not include anything documented in the project's [Avoid these Topics](https://github.com/instructlab/taxonomy/blob/main/docs/SKILLS_GUIDE.md#avoid-these-topics) guidelines
3 changes: 3 additions & 0 deletions taxonomy/.github/workflows/actionlint.dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Since dependabot cannot update workflows using docker,
# we use this indirection since dependabot can update this file.
FROM rhysd/actionlint:1.7.7@sha256:887a259a5a534f3c4f36cb02dca341673c6089431057242cdc931e9f133147e9
49 changes: 49 additions & 0 deletions taxonomy/.github/workflows/actionlint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# SPDX-License-Identifier: Apache-2.0

name: Lint GitHub Actions workflows
on:
push:
branches:
- "main"
paths:
- '.github/workflows/*.ya?ml'
- '.github/workflows/actionlint.*' # This workflow
pull_request:
branches:
- "main"
paths:
- '.github/workflows/*.ya?ml'
- '.github/workflows/actionlint.*' # This workflow

env:
LC_ALL: en_US.UTF-8

defaults:
run:
shell: bash

permissions:
contents: read

jobs:
actionlint:
runs-on: ubuntu-latest
steps:
- name: "Harden Runner"
uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
with:
egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs

- name: "Checkout"
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: 0

- name: "Download actionlint"
run: |
docker build --tag actionlint - < .github/workflows/actionlint.dockerfile

- name: "Check workflow files"
run: |
echo "::add-matcher::.github/workflows/matchers/actionlint.json"
docker run --volume="${PWD}:/repo" --workdir=/repo actionlint -color
46 changes: 46 additions & 0 deletions taxonomy/.github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# SPDX-License-Identifier: Apache-2.0

name: Lint Markdown documents

on:
push:
branches:
- "main"
paths:
- '**/*.md'
- '.markdownlint-cli2.yaml'
- '.github/workflows/docs.yml' # This workflow
pull_request:
branches:
- "main"
paths:
- '**/*.md'
- '.markdownlint-cli2.yaml'
- '.github/workflows/docs.yml' # This workflow

env:
LC_ALL: en_US.UTF-8

defaults:
run:
shell: bash

permissions:
contents: read

jobs:
markdown-lint:
runs-on: ubuntu-latest
steps:
- name: "Harden Runner"
uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
with:
egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs
- name: "Checkout"
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: 0
- name: "Check Markdown documents"
uses: DavidAnson/markdownlint-cli2-action@05f32210e84442804257b2a6f20b273450ec8265 # v19.1.0
with:
globs: '**/*.md'
57 changes: 57 additions & 0 deletions taxonomy/.github/workflows/insight.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# SPDX-License-Identifier: Apache-2.0

name: CoC insight analysis

run-name: ${{ github.event.workflow_run.display_title || github.workflow }}

on:
workflow_run:
workflows:
- "Lint compositional_skills and knowledge"
types:
- completed

env:
LC_ALL: en_US.UTF-8

defaults:
run:
shell: bash

permissions:
contents: read

jobs:
insight-analysis:
runs-on: ubuntu-latest
if: ${{ (github.event.workflow_run.event == 'pull_request') && (github.repository == 'instructlab/taxonomy') && (github.event.workflow_run.conclusion == 'success') }}
name: Run insight analysis
steps:
- name: "Harden Runner"
uses: step-security/harden-runner@4d991eb9b905ef189e4c376166672c3f2f230481 # v2.11.0
with:
egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs

- name: "Debug info"
run: |
jq '.' "$GITHUB_EVENT_PATH"

- name: "Download Pull Request number"
uses: actions/download-artifact@cc203385981b70ca67e1cc392babf9cc229d5806 # v4.1.9
with:
name: pull_request_number
run-id: ${{ github.event.workflow_run.id }}
github-token: ${{ secrets.GITHUB_TOKEN }}

- name: "Get Pull Request number"
run: |
echo "PULL_REQUEST_NUMBER=$(cat pull_request_number.txt)" >> "$GITHUB_ENV"

- name: "Invoke insight analysis handler"
if: ${{ fromJSON(env.PULL_REQUEST_NUMBER) != 0 }}
run: |
curl -X "POST" "https://pr-analysis-handler.1fuhf5gskmng.us-east.codeengine.appdomain.cloud/analyze-pr?pr_number=${PULL_REQUEST_NUMBER}&owner=${REPOSITORY_OWNER}&repo=${REPOSITORY_NAME}" -H "accept: application/json" -H "Authorization: Bearer ${ANALYSIS_TOKEN}"
env:
REPOSITORY_OWNER: ${{ github.repository_owner }}
REPOSITORY_NAME: ${{ github.event.repository.name }}
ANALYSIS_TOKEN: ${{ secrets.COC_ANALYSIS_TOKEN }}
Loading