-
-
Notifications
You must be signed in to change notification settings - Fork 4.7k
docs/community/legal: optimize repository health, structure, and compliance #251
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
java-ai-mlm
wants to merge
1
commit into
rohitg00:main
Choose a base branch
from
java-ai-mlm:optimize-repo-health
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| { | ||
| "name": "\u251c\u2500\u2500 prompt-loss-function-selector.md Dev", | ||
| "image": "mcr.microsoft.com/devcontainers/python", | ||
| "features": {}, | ||
| "postCreateCommand": "python -m pip install -r requirements.txt", | ||
| "customizations": { | ||
| "vscode": { | ||
| "extensions": [ | ||
| "yzhang.markdown-all-in-one", | ||
| "DavidAnson.vscode-markdownlint", | ||
| "ms-python.python" | ||
| ] | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # .gitattributes - GitHub Linguist overrides for accurate language detection | ||
|
|
||
| # Generated and vendored files | ||
| *.min.js linguist-generated | ||
| *.min.css linguist-generated | ||
| dist/** linguist-generated | ||
| vendor/** linguist-vendored | ||
| third_party/** linguist-vendored | ||
|
|
||
| # Markdown-heavy skill and documentation repo | ||
| *.sh linguist-documentation | ||
| *.ps1 linguist-documentation | ||
| install.* linguist-documentation | ||
| *.md linguist-detectable |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| # Global owner for this repository | ||
| * @rohitg00 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| name: Bug Report | ||
| description: Report a bug or unexpected behavior | ||
| title: "[Bug]: " | ||
| labels: ["bug"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: "Thanks for reporting. Please fill in the details below so we can reproduce the problem." | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Bug Description | ||
| description: What happened? | ||
| placeholder: Describe the bug... | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: reproduction | ||
| attributes: | ||
| label: Steps to Reproduce | ||
| description: How can we reproduce this? | ||
| value: | | ||
| 1. | ||
| 2. | ||
| 3. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expected | ||
| attributes: | ||
| label: Expected Behavior | ||
| description: What should have happened? | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: command | ||
| attributes: | ||
| label: Command Used | ||
| placeholder: e.g., github audit --path /repo | ||
| - type: dropdown | ||
| id: os | ||
| attributes: | ||
| label: Operating System | ||
| options: | ||
| - Windows | ||
| - macOS | ||
| - Linux | ||
| - Other | ||
| - type: textarea | ||
| id: additional | ||
| attributes: | ||
| label: Additional Context | ||
| description: Error output, screenshots, links, or anything else that helps. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: Support | ||
| url: https://github.com/rohitg00/ai-engineering-from-scratch/issues | ||
| about: Use this support link for questions before opening a new issue. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| name: Feature Request | ||
| description: Suggest a new feature or improvement | ||
| title: "[Feature]: " | ||
| labels: ["enhancement"] | ||
| body: | ||
| - type: textarea | ||
| id: problem | ||
| attributes: | ||
| label: Problem Statement | ||
| description: What problem does this solve? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: solution | ||
| attributes: | ||
| label: Proposed Solution | ||
| description: How should this work? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: Alternatives Considered | ||
| description: Other approaches or workarounds you have considered. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,23 @@ | ||
| <!-- Thanks for contributing. Fill out what applies. Delete sections that don't. --> | ||
| ## Summary | ||
|
|
||
| ## What this PR does | ||
| Briefly describe what changed and why. | ||
|
|
||
| <!-- One-sentence summary. --> | ||
| ## Type of Change | ||
|
|
||
| ## Kind of change | ||
| - [ ] Bug fix | ||
| - [ ] New feature | ||
| - [ ] Breaking change | ||
| - [ ] Documentation update | ||
| - [ ] Maintenance / tooling update | ||
|
|
||
| - [ ] New lesson | ||
| - [ ] Fix to an existing lesson | ||
| - [ ] Translation | ||
| - [ ] New output (prompt, skill, agent, MCP server) | ||
| - [ ] Docs / website / tooling | ||
| ## Testing | ||
|
|
||
| ## Checklist | ||
|
|
||
| - [ ] Code runs without errors with the listed dependencies | ||
| - [ ] No comments in code files (docs explain, code is self-explanatory) | ||
| - [ ] Built from scratch first, then shown with a framework (for new lessons) | ||
| - [ ] Lesson folder matches `LESSON_TEMPLATE.md` structure | ||
| - [ ] ROADMAP.md row for the lesson is a markdown link (`[Name](phases/...)`), not bare text | ||
| - [ ] One lesson per commit (atomic per-lesson rule) | ||
| - [ ] Tested locally / code output matches what `docs/en.md` claims | ||
|
|
||
| ## Phase / lesson | ||
| - [ ] Tests pass locally | ||
| - [ ] Relevant manual checks completed | ||
| - [ ] Documentation updated if behavior changed | ||
|
|
||
| <!-- e.g. Phase 5 · 03-tokenizers --> | ||
|
|
||
| ## Notes for reviewer | ||
| ## Checklist | ||
|
|
||
| <!-- Anything surprising, any deviations from the template, open questions. --> | ||
| - [ ] Changes are scoped and focused | ||
| - [ ] No credentials or local env files were committed | ||
| - [ ] I reviewed the diff before opening this PR |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| version: 2 | ||
| updates: | ||
| - package-ecosystem: "pip" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "weekly" | ||
| open-pull-requests-limit: 5 | ||
| - package-ecosystem: "github-actions" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "weekly" | ||
| open-pull-requests-limit: 5 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| changelog: | ||
| exclude: | ||
| labels: | ||
| - ignore-for-release | ||
| authors: | ||
| - dependabot | ||
| - dependabot[bot] | ||
| categories: | ||
| - title: Breaking Changes | ||
| labels: | ||
| - breaking | ||
| - title: New Features | ||
| labels: | ||
| - enhancement | ||
| - feature | ||
| - title: Bug Fixes | ||
| labels: | ||
| - bug | ||
| - fix | ||
| - title: Security | ||
| labels: | ||
| - security | ||
| - title: Documentation | ||
| labels: | ||
| - docs | ||
| - documentation | ||
| - title: Other Changes | ||
| labels: | ||
| - "*" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| name: CI | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| pull_request: | ||
| branches: [main] | ||
|
|
||
| jobs: | ||
| lint: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - name: Lint Markdown | ||
| uses: DavidAnson/markdownlint-cli2-action@v19 | ||
| with: | ||
| globs: "**/*.md" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -57,3 +57,4 @@ mlruns/ | |
| .link-cache.json | ||
| .claude/ | ||
| catalog.json | ||
| .github-audit/ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| cff-version: 1.2.0 | ||
| message: "If you use this software, please cite it as below." | ||
| title: "├── prompt-loss-function-selector.md" | ||
| abstract: "Repository for ├── prompt-loss-function-selector.md." | ||
| type: software | ||
| authors: | ||
| - family-names: "rohitg00" | ||
| repository-code: "https://github.com/rohitg00/ai-engineering-from-scratch" | ||
| version: "0.1.0" | ||
| date-released: "2026-06-03" | ||
| license: "MIT" | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct the citation title and abstract.
The
titleandabstractfields reference├── prompt-loss-function-selector.md, which appears to be a copy-paste artifact from a directory tree listing. This doesn't match the repository name or purpose.Expected values should reference the full curriculum, such as:
title: "AI Engineering from Scratch"abstract: "A comprehensive curriculum covering 503 lessons across 20 phases..."📝 Proposed fix
📝 Committable suggestion
🤖 Prompt for AI Agents