chore: Add basic documentation + essential GitHub workflows#1
Conversation
Documentation updates: - Update README.md - Add CONTRIBUTING guide - Add MAINTAINERS guide Git template updates: - Add issue templates for: bug reports, design changes, and feature requests - Add pull request template Essential GitHub workflows: - Add lint.yml for running lint checks - Python linting: add MyPy and PyLint - Shell linting: Add shellcheck Configurations: - Add Mergify config for Mergify bot - Add .isort.cfg and .pylintrc for Python formatting configs - Add yamllint.yaml for formatting YAML files Testing: - Add tox.ini for setting up testing environments Signed-off-by: Courtney Pacheco <6019922+courtneypacheco@users.noreply.github.com>
courtneypacheco
left a comment
courtneypacheco
left a comment
There was a problem hiding this comment.
Some info about this PR
There was a problem hiding this comment.
Taken directly from: https://github.com/instructlab/instructlab/blob/main/.yamllint.yaml
The only difference is I removed the ignore part of the config
There was a problem hiding this comment.
Taken directly from: https://github.com/instructlab/instructlab/blob/main/.pylintrc
No modifications made here
There was a problem hiding this comment.
Taken directly from: https://github.com/instructlab/instructlab/blob/main/.isort.cfg
This typically executes on Python code. I took the exact contents, except removed the skip_glob piece because we don't need that exception (yet).
There was a problem hiding this comment.
Taken directly from here with no changes: https://github.com/instructlab/instructlab/blob/main/.github/workflows/shellcheck.yaml
There was a problem hiding this comment.
Taken directly from here: https://github.com/instructlab/instructlab/blob/main/.github/mergify.yml
I removed anything instructlab specific, like references to instructlab/src, src/instructlab/profiles, etc.. I also removed spell checking since I don't think we need a spell checker for this repo at this time.
There was a problem hiding this comment.
There was a problem hiding this comment.
There was a problem hiding this comment.
Taken directly from: https://github.com/instructlab/instructlab/blob/main/.github/workflows/lint.yml
I removed instructlab-specific configs, like references to src/instructlab/profiles.
I also removed security lint... for now! I will add that back in a future commit.
There was a problem hiding this comment.
I will add that back in a future commit. do we want to log a ticket to track it ?
There was a problem hiding this comment.
Yes, we definitely want an issue! I can file one.
There was a problem hiding this comment.
Mostly lifted from here: https://github.com/instructlab/instructlab/blob/main/tox.ini
I removed:
- functional tests (since we don't have them)
- fastlint (since we don't need that right now)
- tomllint (since we're not building a package)
- docs (since we're not building any docs)
| - or: | ||
| - files~=\.py$ | ||
| - files~=^requirements.*\.txt$ | ||
| - files=tox.ini |
There was a problem hiding this comment.
Would we be in need of verifying tox related files ?
There was a problem hiding this comment.
Short answer: yes.
Long answer:
tox.ini contains configs for linting, like ruff, mypy, etc. So if someone edits tox.ini, they are likely editing linting configs.
I took the tox.ini file from our core repo (instructlab/instructlab) and modified it here. In the core repo, this file is used to define test envs and also run commands related to packaging and publishing (specifically wheel building and sphinx docs generation). Since I've removed all the packaging and publishing pieces, the only pieces left are related to testing.
|
I think apart from the nit picks, it looks good to me. @courtneypacheco. Coming to the access to this repository, would the maintainers list be derived from Organization level or should the list be different ? |
courtneypacheco
added
chore
danmcp
left a comment
danmcp
left a comment
There was a problem hiding this comment.
Approving as a first pass to get the repo bootstrapped
courtneypacheco
deleted the
add-essential-workflows-and-documentation
branch
3 participants
Documentation updates:
Git template updates:
Essential GitHub workflows:
Configurations:
Testing: