From 55a6aeabfb097ecefbb803b4f2b0fedf54fdeb96 Mon Sep 17 00:00:00 2001 From: Calvin Secrest Date: Tue, 4 Aug 2026 15:27:39 -0400 Subject: [PATCH] Add repository readiness report --- .editorconfig | 16 ++ .github/ISSUE_TEMPLATE/bug_report.yml | 43 ++++ .../documentation_improvement.yml | 35 ++++ .github/ISSUE_TEMPLATE/engineering_rfc.yml | 41 ++++ .github/ISSUE_TEMPLATE/feature_request.yml | 34 ++++ .github/PULL_REQUEST_TEMPLATE.md | 27 +++ .github/workflows/broken-link-check.yml | 33 +++ .github/workflows/markdown-lint.yml | 29 +++ .github/workflows/spellcheck.yml | 35 ++++ .gitignore | 25 +++ CODEOWNERS | 9 + CODE_OF_CONDUCT.md | 75 +++++++ CONTRIBUTING.md | 33 +++ README.md | 37 ++-- REPOSITORY_READINESS_REPORT.md | 188 ++++++++++++++++++ SECURITY.md | 27 +++ docs/engineering-handbook/01-purpose.md | 17 ++ .../02-engineering-principles.md | 17 ++ .../03-engineering-roles.md | 17 ++ .../04-communication-standards.md | 17 ++ .../05-github-workflow.md | 17 ++ .../06-branching-strategy.md | 17 ++ .../07-commit-message-standards.md | 17 ++ .../08-pull-request-process.md | 17 ++ .../09-code-review-standards.md | 17 ++ .../10-repository-standards.md | 17 ++ .../11-documentation-standards.md | 17 ++ .../12-ci-cd-standards.md | 17 ++ .../13-security-standards.md | 17 ++ .../14-issue-management.md | 17 ++ .../15-project-documentation.md | 17 ++ .../16-volunteer-expectations.md | 17 ++ .../17-professional-conduct.md | 17 ++ .../18-engineering-escalation.md | 17 ++ .../19-release-management.md | 17 ++ .../20-engineering-metrics.md | 17 ++ .../21-continuous-improvement.md | 17 ++ .../22-repository-checklist.md | 17 ++ .../23-volunteer-onboarding-checklist.md | 17 ++ .../24-revision-history.md | 17 ++ .../25-jfa-engineering-principles.md | 17 ++ .../26-github-governance.md | 17 ++ .../27-cloud-infrastructure-standards.md | 17 ++ 43 files changed, 1122 insertions(+), 24 deletions(-) create mode 100644 .editorconfig create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation_improvement.yml create mode 100644 .github/ISSUE_TEMPLATE/engineering_rfc.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/workflows/broken-link-check.yml create mode 100644 .github/workflows/markdown-lint.yml create mode 100644 .github/workflows/spellcheck.yml create mode 100644 .gitignore create mode 100644 CODEOWNERS create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 REPOSITORY_READINESS_REPORT.md create mode 100644 SECURITY.md create mode 100644 docs/engineering-handbook/01-purpose.md create mode 100644 docs/engineering-handbook/02-engineering-principles.md create mode 100644 docs/engineering-handbook/03-engineering-roles.md create mode 100644 docs/engineering-handbook/04-communication-standards.md create mode 100644 docs/engineering-handbook/05-github-workflow.md create mode 100644 docs/engineering-handbook/06-branching-strategy.md create mode 100644 docs/engineering-handbook/07-commit-message-standards.md create mode 100644 docs/engineering-handbook/08-pull-request-process.md create mode 100644 docs/engineering-handbook/09-code-review-standards.md create mode 100644 docs/engineering-handbook/10-repository-standards.md create mode 100644 docs/engineering-handbook/11-documentation-standards.md create mode 100644 docs/engineering-handbook/12-ci-cd-standards.md create mode 100644 docs/engineering-handbook/13-security-standards.md create mode 100644 docs/engineering-handbook/14-issue-management.md create mode 100644 docs/engineering-handbook/15-project-documentation.md create mode 100644 docs/engineering-handbook/16-volunteer-expectations.md create mode 100644 docs/engineering-handbook/17-professional-conduct.md create mode 100644 docs/engineering-handbook/18-engineering-escalation.md create mode 100644 docs/engineering-handbook/19-release-management.md create mode 100644 docs/engineering-handbook/20-engineering-metrics.md create mode 100644 docs/engineering-handbook/21-continuous-improvement.md create mode 100644 docs/engineering-handbook/22-repository-checklist.md create mode 100644 docs/engineering-handbook/23-volunteer-onboarding-checklist.md create mode 100644 docs/engineering-handbook/24-revision-history.md create mode 100644 docs/engineering-handbook/25-jfa-engineering-principles.md create mode 100644 docs/engineering-handbook/26-github-governance.md create mode 100644 docs/engineering-handbook/27-cloud-infrastructure-standards.md diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..e27eb6e --- /dev/null +++ b/.editorconfig @@ -0,0 +1,16 @@ +# EditorConfig keeps formatting consistent across editors. +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +indent_style = space +indent_size = 2 +trim_trailing_whitespace = true + +[*.md] +trim_trailing_whitespace = false + +[Makefile] +indent_style = tab diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..f3be620 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,43 @@ +name: Bug Report +description: Report a repository, workflow, or documentation defect. +title: "Bug: " +labels: + - bug +body: + - type: markdown + attributes: + value: | + Thank you for helping improve the NTARI Developer Portal. Please provide enough detail for maintainers to reproduce or verify the issue. + - type: textarea + id: problem + attributes: + label: Problem + description: What is broken or behaving unexpectedly? + placeholder: Describe the issue clearly. + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What should happen instead? + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to Reproduce + description: Provide steps, links, file paths, or screenshots when relevant. + placeholder: | + 1. Go to ... + 2. Open ... + 3. Observe ... + validations: + required: false + - type: textarea + id: context + attributes: + label: Additional Context + description: Add any other relevant details. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/documentation_improvement.yml b/.github/ISSUE_TEMPLATE/documentation_improvement.yml new file mode 100644 index 0000000..09dddd4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_improvement.yml @@ -0,0 +1,35 @@ +name: Documentation Improvement +description: Request a clarification, correction, or future documentation topic. +title: "Docs: " +labels: + - documentation +body: + - type: textarea + id: location + attributes: + label: Documentation Location + description: Link the page, file, heading, or proposed location. + placeholder: docs/engineering-handbook/... + validations: + required: false + - type: textarea + id: improvement + attributes: + label: Requested Improvement + description: What should be clarified, corrected, or added? + validations: + required: true + - type: textarea + id: rationale + attributes: + label: Rationale + description: Why is this change useful or necessary? + validations: + required: true + - type: textarea + id: notes + attributes: + label: Additional Notes + description: Add references, examples, or related discussions. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/engineering_rfc.yml b/.github/ISSUE_TEMPLATE/engineering_rfc.yml new file mode 100644 index 0000000..6f083b2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/engineering_rfc.yml @@ -0,0 +1,41 @@ +name: Engineering RFC +description: Propose a significant engineering process, architecture, or governance decision. +title: "RFC: " +labels: + - rfc +body: + - type: textarea + id: summary + attributes: + label: Summary + description: Provide a concise overview of the proposal. + validations: + required: true + - type: textarea + id: problem + attributes: + label: Problem Statement + description: What problem or opportunity does this RFC address? + validations: + required: true + - type: textarea + id: proposal + attributes: + label: Proposal + description: Describe the proposed decision, process, or standard. + validations: + required: true + - type: textarea + id: impact + attributes: + label: Impact + description: Who or what would be affected by this proposal? + validations: + required: true + - type: textarea + id: open_questions + attributes: + label: Open Questions + description: List unresolved questions, risks, or decisions needed. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..fad0e2e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,34 @@ +name: Feature Request +description: Suggest a repository capability, workflow, or documentation enhancement. +title: "Feature: " +labels: + - enhancement +body: + - type: textarea + id: summary + attributes: + label: Summary + description: What capability or improvement are you proposing? + validations: + required: true + - type: textarea + id: motivation + attributes: + label: Motivation + description: Why would this be valuable for NTARI maintainers or contributors? + validations: + required: true + - type: textarea + id: proposal + attributes: + label: Proposed Approach + description: Describe the expected behavior, workflow, or implementation direction. + validations: + required: false + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: List alternatives or tradeoffs if applicable. + validations: + required: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..b84a81c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,27 @@ +## Summary + + + +## Type of Change + +- [ ] Documentation update +- [ ] Repository configuration +- [ ] Governance or process update +- [ ] Engineering RFC +- [ ] Other maintenance + +## Related Issues or RFCs + + + +## Review Checklist + +- [ ] The change is scoped and reviewable. +- [ ] Markdown renders correctly on GitHub. +- [ ] Links are valid or intentionally pending. +- [ ] Spelling and terminology have been reviewed. +- [ ] No confidential, private, or security-sensitive information is included. + +## Additional Notes + + diff --git a/.github/workflows/broken-link-check.yml b/.github/workflows/broken-link-check.yml new file mode 100644 index 0000000..80aa6e7 --- /dev/null +++ b/.github/workflows/broken-link-check.yml @@ -0,0 +1,33 @@ +name: Broken Link Check + +on: + pull_request: + paths: + - "**/*.md" + - ".github/workflows/broken-link-check.yml" + push: + branches: + - main + paths: + - "**/*.md" + - ".github/workflows/broken-link-check.yml" + schedule: + - cron: "0 12 * * 1" + +permissions: + contents: read + +jobs: + link-check: + name: Check Markdown Links + runs-on: ubuntu-latest + steps: + - name: Check out repository + uses: actions/checkout@v4 + + - name: Run Lychee link checker + uses: lycheeverse/lychee-action@v2 + with: + args: --verbose --no-progress "**/*.md" + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/markdown-lint.yml b/.github/workflows/markdown-lint.yml new file mode 100644 index 0000000..4e182ef --- /dev/null +++ b/.github/workflows/markdown-lint.yml @@ -0,0 +1,29 @@ +name: Markdown Lint + +on: + pull_request: + paths: + - "**/*.md" + - ".github/workflows/markdown-lint.yml" + push: + branches: + - main + paths: + - "**/*.md" + - ".github/workflows/markdown-lint.yml" + +permissions: + contents: read + +jobs: + markdown-lint: + name: Lint Markdown + runs-on: ubuntu-latest + steps: + - name: Check out repository + uses: actions/checkout@v4 + + - name: Run markdownlint-cli2 + uses: DavidAnson/markdownlint-cli2-action@v19 + with: + globs: "**/*.md" diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml new file mode 100644 index 0000000..47b58b6 --- /dev/null +++ b/.github/workflows/spellcheck.yml @@ -0,0 +1,35 @@ +name: Spellcheck + +on: + pull_request: + paths: + - "**/*.md" + - ".github/workflows/spellcheck.yml" + push: + branches: + - main + paths: + - "**/*.md" + - ".github/workflows/spellcheck.yml" + +permissions: + contents: read + +jobs: + spellcheck: + name: Check Spelling + runs-on: ubuntu-latest + steps: + - name: Check out repository + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.x" + + - name: Install codespell + run: python -m pip install --upgrade codespell + + - name: Run codespell + run: codespell --skip=".git" --ignore-words-list="NTARI,JFA" diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d21d771 --- /dev/null +++ b/.gitignore @@ -0,0 +1,25 @@ +# Operating system files +.DS_Store +Thumbs.db + +# Editor and IDE files +.vscode/ +.idea/ +*.swp +*.swo + +# Logs and temporary files +*.log +*.tmp +*.temp + +# Dependency directories and generic build output +node_modules/ +dist/ +build/ +.cache/ + +# Local environment files +.env +.env.* +!.env.example diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..aea1150 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,9 @@ +# Placeholder CODEOWNERS for the NTARI Developer Portal. +# Replace these entries with the appropriate NTARI GitHub teams or maintainers. + +* @NTARI-RAND/maintainers +/README.md @NTARI-RAND/docs-maintainers +/CONTRIBUTING.md @NTARI-RAND/docs-maintainers +/CODE_OF_CONDUCT.md @NTARI-RAND/maintainers +/SECURITY.md @NTARI-RAND/maintainers +/LICENSE @NTARI-RAND/maintainers diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..661a92f --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,75 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our community include: + +- Demonstrating empathy and kindness toward other people. +- Being respectful of differing opinions, viewpoints, and experiences. +- Giving and gracefully accepting constructive feedback. +- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience. +- Focusing on what is best not just for us as individuals, but for the overall community. + +Examples of unacceptable behavior include: + +- The use of sexualized language or imagery, and sexual attention or advances of any kind. +- Trolling, insulting or derogatory comments, and personal or political attacks. +- Public or private harassment. +- Publishing others' private information, such as a physical or email address, without their explicit permission. +- Other conduct which could reasonably be considered inappropriate in a professional setting. + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official email address, posting through an official social media account, or acting as an appointed representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement through the reporting channels designated by NTARI. All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact:** Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. + +**Consequence:** A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact:** A violation through a single incident or series of actions. + +**Consequence:** A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. + +### 3. Temporary Ban + +**Community Impact:** A serious violation of community standards, including sustained inappropriate behavior. + +**Consequence:** A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact:** Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. + +**Consequence:** A permanent ban from any sort of public interaction within the community. + +## Attribution + +This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at . + +Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..fca81b1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing to the NTARI Developer Portal + +Thank you for helping improve the NTARI Developer Portal. This repository is maintained by the Network Theory Applied Research Institute (NTARI) as the authoritative home for NTARI developer-facing documentation. + +## What to Contribute + +At this stage, contributions should focus on repository governance, documentation structure proposals, typo fixes, clarity improvements, and issue reports. Full documentation pages and handbook content should not be added until NTARI opens the relevant documentation area for review. + +## Documentation Contribution Guidelines + +- Use clear, concise Markdown that renders well on GitHub. +- Keep pull requests focused on a single purpose. +- Prefer small, reviewable changes over large unstructured updates. +- Avoid adding confidential, private, or security-sensitive information. +- Link related issues, discussions, or decisions when available. +- Do not introduce documentation pages before the relevant section has been approved for creation. + +## Opening Issues + +Use GitHub issues to report documentation gaps, broken links, inaccurate wording, repository configuration problems, or proposed improvements. Include enough context for maintainers to understand the requested change. + +## Pull Request Expectations + +A good documentation pull request should include: + +1. A short summary of the change. +2. The reason the change is needed. +3. Any related issue or discussion links. +4. Confirmation that the Markdown has been reviewed for readability. + +## Licensing + +By contributing to this repository, you agree that your contributions will be licensed under the GNU Affero General Public License v3.0, as described in [`LICENSE`](LICENSE). diff --git a/README.md b/README.md index ee7a20a..810c7e7 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,29 @@ # NTARI Developer Portal -The NTARI Developer Portal is the central documentation repository for engineering, architecture, operations, and contributor guidance across NTARI projects. +The NTARI Developer Portal is the official documentation repository maintained by the Network Theory Applied Research Institute (NTARI). -## Purpose +This repository will become the authoritative source for NTARI developer-facing documentation, including future engineering guidance, architecture references, operational notes, project documentation, and contributor resources. The portal is currently maintained as a Markdown-first GitHub repository and may later be published with a dedicated documentation platform such as Docusaurus. -This repository contains: +## Current Scope -- Engineering Handbook -- Janus Facing Architecture (JFA) -- GitHub Governance -- Cloud & Infrastructure Standards -- Volunteer Onboarding -- RFCs -- Operations Documentation +This repository currently defines the governance and contribution foundation for the Developer Portal. Documentation pages have not been created yet. -## Projects +## Maintainer -The standards in this repository apply to: +Documentation in this repository is maintained by NTARI. -- SoHoLink -- Agrinet -- Tell -- Janusand -- NTARI OS -- Future NTARI projects +## Contributing -## Getting Started +Documentation contributions are welcome through GitHub issues and pull requests. Please read [`CONTRIBUTING.md`](CONTRIBUTING.md) before proposing changes. -New contributors should begin with: +## Code of Conduct -docs/engineering-handbook/ +Participation in this repository is governed by the Contributor Covenant Code of Conduct. See [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md). -## Contributing +## Security and Repository Issues -See CONTRIBUTING.md. +To report documentation integrity problems, repository configuration concerns, or potential security issues, see [`SECURITY.md`](SECURITY.md). ## License -See LICENSE. +This repository is licensed under the GNU Affero General Public License v3.0. See [`LICENSE`](LICENSE). diff --git a/REPOSITORY_READINESS_REPORT.md b/REPOSITORY_READINESS_REPORT.md new file mode 100644 index 0000000..2e42e72 --- /dev/null +++ b/REPOSITORY_READINESS_REPORT.md @@ -0,0 +1,188 @@ +# Repository Readiness Report + +## Scope + +This report reviews the NTARI Developer Portal repository for open-source +readiness. It evaluates structure, Markdown conventions, community health, +GitHub compatibility, future Docusaurus compatibility, scalability, +accessibility, and cleanliness. + +This report does not add handbook or documentation-body content. + +## Executive Summary + +The repository is ready as an early Markdown-first open-source documentation +foundation. It has clear governance files, issue and pull request templates, +placeholder Engineering Handbook pages, and GitHub Actions workflows for basic +Markdown quality gates. + +The repository should remain lightweight until NTARI approves substantive +handbook content. The main improvements to prioritize next are ownership +finalization, lint configuration tuning, link-check policy decisions, and future +Docusaurus planning files when the project is ready for publication tooling. + +## Review Areas + +### Folder Organization + +Status: Ready with minor future improvements. + +Findings: + +- Root governance files are easy to discover. +- GitHub configuration is organized under `.github/`. +- Engineering Handbook placeholders are isolated under + `docs/engineering-handbook/`. +- No unrelated application, build, or Docusaurus folders are present. + +Recommended improvements: + +- Add top-level documentation index files only when NTARI is ready to define + navigation. +- Add future documentation areas incrementally instead of creating broad empty + trees. + +### Markdown Structure + +Status: Ready for placeholders. + +Findings: + +- Markdown files use clear headings and consistent placeholder structure. +- Handbook files avoid substantive handbook content. +- Governance files are readable in GitHub's Markdown renderer. + +Recommended improvements: + +- Add a Markdown lint configuration once NTARI agrees on line length, + heading-style, and list-format rules. +- Add front matter only if and when Docusaurus or another static site generator + is introduced. + +### Community Health Files + +Status: Ready with placeholder ownership. + +Findings: + +- `README.md`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, `SECURITY.md`, + `LICENSE`, and `CODEOWNERS` are present. +- Contributor Covenant 2.1 language is included. +- Security guidance covers documentation and repository integrity concerns. +- CODEOWNERS uses placeholder NTARI teams. + +Recommended improvements: + +- Replace placeholder CODEOWNERS teams with confirmed GitHub teams. +- Add public contact or private reporting details to `SECURITY.md` when NTARI + has approved disclosure channels. +- Add issue labels in GitHub to match the configured issue forms. + +### GitHub Compatibility + +Status: Ready for GitHub-hosted collaboration. + +Findings: + +- Pull request and issue templates are in GitHub-supported locations. +- Issue templates use GitHub Issue Forms YAML. +- GitHub Actions workflows are present for Markdown linting, link checking, + and spellcheck. +- Workflow permissions are read-only by default. + +Recommended improvements: + +- Confirm that referenced GitHub teams exist before enforcing CODEOWNERS. +- Confirm third-party GitHub Actions are approved by NTARI governance. +- Consider pinning actions by full commit SHA for stricter supply-chain control. + +### Future Docusaurus Compatibility + +Status: Compatible with future adoption. + +Findings: + +- Markdown-first files under `docs/` are compatible with a future Docusaurus + migration path. +- Numeric filename prefixes can support stable ordering in generated sidebars. +- No Docusaurus dependency, configuration, or generated output is present. + +Recommended improvements: + +- Add Docusaurus only in a dedicated future change. +- Decide whether future pages should use front matter for sidebar labels, + slugs, tags, and descriptions. +- Reserve generated output directories in `.gitignore` only when tooling is + actually introduced. + +### Scalability + +Status: Good initial foundation. + +Findings: + +- The repository separates governance, GitHub configuration, and handbook + placeholders. +- Numbered handbook files support predictable growth. +- Issue forms separate different intake paths for maintainers. + +Recommended improvements: + +- Define documentation ownership by section when real content begins. +- Add templates for RFCs, runbooks, and decision records only when NTARI is + ready to accept those document types. +- Consider adding a changelog or revision process after the handbook receives + substantive content. + +### Accessibility + +Status: Ready for text-first content. + +Findings: + +- Current content is text-based and readable without images or scripts. +- No inaccessible diagrams, media, or interactive components are present. +- Issue and pull request forms use clear labels and descriptions. + +Recommended improvements: + +- Require alt text for future images and diagrams. +- Prefer descriptive link text in future documentation. +- Add accessibility checks to documentation review guidance before publishing + richer visual content. + +### Repository Cleanliness + +Status: Clean. + +Findings: + +- The working tree was clean before this report was added. +- The repository has no empty tracked directories. +- No generated build artifacts are tracked. +- `.gitignore` covers common local files, dependency folders, caches, and build + output. + +Recommended improvements: + +- Keep generated files out of version control. +- Avoid adding broad placeholder trees before navigation and ownership are + defined. +- Periodically review workflow logs after CI starts running on pull requests. + +## Overall Readiness Assessment + +The repository is ready for early open-source collaboration and controlled +Markdown-first documentation development. It is not yet ready for a public +published documentation site because navigation, ownership, content review +policy, and publication tooling have not been finalized. + +## Prioritized Improvements + +1. Confirm and replace placeholder CODEOWNERS teams. +2. Configure repository labels to match issue forms. +3. Add NTARI-approved sensitive issue reporting details to `SECURITY.md`. +4. Decide Markdown lint rules and add a repository lint configuration. +5. Review third-party GitHub Actions policy and pin actions if required. +6. Define a future Docusaurus migration plan before adding Docusaurus files. +7. Add accessibility requirements before accepting images, diagrams, or media. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..1c6236a --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,27 @@ +# Security Policy + +NTARI maintains this repository as the authoritative home for Developer Portal documentation and related repository governance files. + +## Reporting Documentation and Repository Issues + +Please report issues that may affect the integrity, safety, or reliability of this repository. Examples include: + +- Incorrect security-sensitive documentation. +- Accidental exposure of private or confidential information. +- Suspicious links or malicious content in documentation. +- Repository configuration problems that could affect reviews, ownership, or publishing. +- Concerns involving licensing, attribution, or contributor trust. + +## How to Report + +If the issue is not sensitive, open a GitHub issue with a clear description and supporting context. + +If the issue is sensitive or could create risk if publicly disclosed, do not open a public issue. Instead, contact the NTARI maintainers through the private reporting channel designated by the organization. If a GitHub private vulnerability reporting workflow is enabled for this repository, use that workflow. + +## Response Expectations + +NTARI maintainers will review reports, determine the appropriate remediation path, and follow up when more information is needed. Response times may vary while this repository is in its initial setup phase. + +## Scope + +This policy applies to documentation, repository configuration, contribution workflows, and files maintained in this repository. diff --git a/docs/engineering-handbook/01-purpose.md b/docs/engineering-handbook/01-purpose.md new file mode 100644 index 0000000..88634be --- /dev/null +++ b/docs/engineering-handbook/01-purpose.md @@ -0,0 +1,17 @@ +# Purpose + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on purpose. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/02-engineering-principles.md b/docs/engineering-handbook/02-engineering-principles.md new file mode 100644 index 0000000..dec2c9c --- /dev/null +++ b/docs/engineering-handbook/02-engineering-principles.md @@ -0,0 +1,17 @@ +# Engineering Principles + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on engineering principles. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/03-engineering-roles.md b/docs/engineering-handbook/03-engineering-roles.md new file mode 100644 index 0000000..739ad0b --- /dev/null +++ b/docs/engineering-handbook/03-engineering-roles.md @@ -0,0 +1,17 @@ +# Engineering Roles + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on engineering roles. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/04-communication-standards.md b/docs/engineering-handbook/04-communication-standards.md new file mode 100644 index 0000000..f780fb9 --- /dev/null +++ b/docs/engineering-handbook/04-communication-standards.md @@ -0,0 +1,17 @@ +# Communication Standards + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on communication standards. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/05-github-workflow.md b/docs/engineering-handbook/05-github-workflow.md new file mode 100644 index 0000000..bfb2f0b --- /dev/null +++ b/docs/engineering-handbook/05-github-workflow.md @@ -0,0 +1,17 @@ +# GitHub Workflow + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on github workflow. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/06-branching-strategy.md b/docs/engineering-handbook/06-branching-strategy.md new file mode 100644 index 0000000..d7a3909 --- /dev/null +++ b/docs/engineering-handbook/06-branching-strategy.md @@ -0,0 +1,17 @@ +# Branching Strategy + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on branching strategy. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/07-commit-message-standards.md b/docs/engineering-handbook/07-commit-message-standards.md new file mode 100644 index 0000000..db04756 --- /dev/null +++ b/docs/engineering-handbook/07-commit-message-standards.md @@ -0,0 +1,17 @@ +# Commit Message Standards + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on commit message standards. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/08-pull-request-process.md b/docs/engineering-handbook/08-pull-request-process.md new file mode 100644 index 0000000..21e570b --- /dev/null +++ b/docs/engineering-handbook/08-pull-request-process.md @@ -0,0 +1,17 @@ +# Pull Request Process + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on pull request process. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/09-code-review-standards.md b/docs/engineering-handbook/09-code-review-standards.md new file mode 100644 index 0000000..9a189da --- /dev/null +++ b/docs/engineering-handbook/09-code-review-standards.md @@ -0,0 +1,17 @@ +# Code Review Standards + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on code review standards. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/10-repository-standards.md b/docs/engineering-handbook/10-repository-standards.md new file mode 100644 index 0000000..cca8a1e --- /dev/null +++ b/docs/engineering-handbook/10-repository-standards.md @@ -0,0 +1,17 @@ +# Repository Standards + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on repository standards. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/11-documentation-standards.md b/docs/engineering-handbook/11-documentation-standards.md new file mode 100644 index 0000000..7a7db4a --- /dev/null +++ b/docs/engineering-handbook/11-documentation-standards.md @@ -0,0 +1,17 @@ +# Documentation Standards + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on documentation standards. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/12-ci-cd-standards.md b/docs/engineering-handbook/12-ci-cd-standards.md new file mode 100644 index 0000000..e6ed038 --- /dev/null +++ b/docs/engineering-handbook/12-ci-cd-standards.md @@ -0,0 +1,17 @@ +# CI/CD Standards + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on ci/cd standards. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/13-security-standards.md b/docs/engineering-handbook/13-security-standards.md new file mode 100644 index 0000000..1ca1612 --- /dev/null +++ b/docs/engineering-handbook/13-security-standards.md @@ -0,0 +1,17 @@ +# Security Standards + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on security standards. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/14-issue-management.md b/docs/engineering-handbook/14-issue-management.md new file mode 100644 index 0000000..5389143 --- /dev/null +++ b/docs/engineering-handbook/14-issue-management.md @@ -0,0 +1,17 @@ +# Issue Management + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on issue management. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/15-project-documentation.md b/docs/engineering-handbook/15-project-documentation.md new file mode 100644 index 0000000..692f8ee --- /dev/null +++ b/docs/engineering-handbook/15-project-documentation.md @@ -0,0 +1,17 @@ +# Project Documentation + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on project documentation. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/16-volunteer-expectations.md b/docs/engineering-handbook/16-volunteer-expectations.md new file mode 100644 index 0000000..4ae3529 --- /dev/null +++ b/docs/engineering-handbook/16-volunteer-expectations.md @@ -0,0 +1,17 @@ +# Volunteer Expectations + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on volunteer expectations. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/17-professional-conduct.md b/docs/engineering-handbook/17-professional-conduct.md new file mode 100644 index 0000000..cf7e3c4 --- /dev/null +++ b/docs/engineering-handbook/17-professional-conduct.md @@ -0,0 +1,17 @@ +# Professional Conduct + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on professional conduct. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/18-engineering-escalation.md b/docs/engineering-handbook/18-engineering-escalation.md new file mode 100644 index 0000000..5351a66 --- /dev/null +++ b/docs/engineering-handbook/18-engineering-escalation.md @@ -0,0 +1,17 @@ +# Engineering Escalation + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on engineering escalation. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/19-release-management.md b/docs/engineering-handbook/19-release-management.md new file mode 100644 index 0000000..eece20c --- /dev/null +++ b/docs/engineering-handbook/19-release-management.md @@ -0,0 +1,17 @@ +# Release Management + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on release management. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/20-engineering-metrics.md b/docs/engineering-handbook/20-engineering-metrics.md new file mode 100644 index 0000000..6e61741 --- /dev/null +++ b/docs/engineering-handbook/20-engineering-metrics.md @@ -0,0 +1,17 @@ +# Engineering Metrics + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on engineering metrics. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/21-continuous-improvement.md b/docs/engineering-handbook/21-continuous-improvement.md new file mode 100644 index 0000000..1ee01ff --- /dev/null +++ b/docs/engineering-handbook/21-continuous-improvement.md @@ -0,0 +1,17 @@ +# Continuous Improvement + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on continuous improvement. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/22-repository-checklist.md b/docs/engineering-handbook/22-repository-checklist.md new file mode 100644 index 0000000..847a8d1 --- /dev/null +++ b/docs/engineering-handbook/22-repository-checklist.md @@ -0,0 +1,17 @@ +# Repository Checklist + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on repository checklist. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/23-volunteer-onboarding-checklist.md b/docs/engineering-handbook/23-volunteer-onboarding-checklist.md new file mode 100644 index 0000000..82484a2 --- /dev/null +++ b/docs/engineering-handbook/23-volunteer-onboarding-checklist.md @@ -0,0 +1,17 @@ +# Volunteer Onboarding Checklist + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on volunteer onboarding checklist. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/24-revision-history.md b/docs/engineering-handbook/24-revision-history.md new file mode 100644 index 0000000..05a4fda --- /dev/null +++ b/docs/engineering-handbook/24-revision-history.md @@ -0,0 +1,17 @@ +# Revision History + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on revision history. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/25-jfa-engineering-principles.md b/docs/engineering-handbook/25-jfa-engineering-principles.md new file mode 100644 index 0000000..708aff6 --- /dev/null +++ b/docs/engineering-handbook/25-jfa-engineering-principles.md @@ -0,0 +1,17 @@ +# JFA Engineering Principles + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on jfa engineering principles. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/26-github-governance.md b/docs/engineering-handbook/26-github-governance.md new file mode 100644 index 0000000..95b3066 --- /dev/null +++ b/docs/engineering-handbook/26-github-governance.md @@ -0,0 +1,17 @@ +# GitHub Governance + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on github governance. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon. diff --git a/docs/engineering-handbook/27-cloud-infrastructure-standards.md b/docs/engineering-handbook/27-cloud-infrastructure-standards.md new file mode 100644 index 0000000..9206b61 --- /dev/null +++ b/docs/engineering-handbook/27-cloud-infrastructure-standards.md @@ -0,0 +1,17 @@ +# Cloud Infrastructure Standards + +## Purpose + +This page is reserved for future NTARI Engineering Handbook guidance on cloud infrastructure standards. + +## Placeholder Sections + +- Overview +- Scope +- Standards +- Responsibilities +- References + +## Status + +Content coming soon.