diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..782ec955 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,88 @@ +name: 🐛 Bug Report +description: Report a bug or unexpected behavior in the Tractatus Framework +title: "[Bug]: " +labels: ["bug", "needs-triage"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report a bug! Please fill out the form below to help us investigate. + + - type: textarea + id: description + attributes: + label: Bug Description + description: A clear and concise description of what the bug is. + placeholder: Tell us what you see... + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Steps to Reproduce + description: Steps to reproduce the behavior + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: What actually happened instead? + validations: + required: true + + - type: dropdown + id: component + attributes: + label: Component + description: Which component is affected? + options: + - BoundaryEnforcer + - CrossReferenceValidator + - ContextPressureMonitor + - InstructionPersistenceClassifier + - MetacognitiveVerifier + - PluralisticDeliberationOrchestrator + - Website/Documentation + - Other + validations: + required: true + + - type: textarea + id: environment + attributes: + label: Environment + description: Please provide your environment details + value: | + - OS: + - Browser (if applicable): + - Node.js version (if applicable): + - Framework version: + + - type: textarea + id: logs + attributes: + label: Relevant Log Output + description: Please copy and paste any relevant log output. This will be automatically formatted. + render: shell + + - type: textarea + id: additional + attributes: + label: Additional Context + description: Add any other context about the problem here (screenshots, related issues, etc.) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..a73d5f70 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: 💬 Ask a Question + url: https://github.com/AgenticGovernance/tractatus-framework/discussions/new?category=q-a + about: Ask questions and discuss with the community + - name: 📖 Documentation + url: https://agenticgovernance.digital/docs.html + about: Read our comprehensive documentation + - name: 📧 Media Inquiries + url: https://agenticgovernance.digital/media-inquiry.html + about: For press, media, and partnership inquiries diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 00000000..cda7f108 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,72 @@ +name: 📖 Documentation Issue +description: Report missing, unclear, or incorrect documentation +title: "[Docs]: " +labels: ["documentation", "needs-triage"] +body: + - type: markdown + attributes: + value: | + Help us improve our documentation! Please describe what's missing, unclear, or incorrect. + + - type: dropdown + id: doc-type + attributes: + label: Documentation Type + description: What type of documentation needs improvement? + options: + - Technical Documentation + - API Reference + - Implementation Guide + - Conceptual/Theoretical + - Tutorial/Getting Started + - Case Study + - Other + validations: + required: true + + - type: input + id: page + attributes: + label: Page/Section + description: Which page or section needs improvement? + placeholder: "e.g., docs.html#boundary-enforcer or /implementer.html" + validations: + required: true + + - type: dropdown + id: issue-type + attributes: + label: Issue Type + description: What kind of documentation issue is this? + options: + - Missing information + - Unclear explanation + - Incorrect information + - Outdated content + - Typo or grammar + - Broken link + - Other + validations: + required: true + + - type: textarea + id: problem + attributes: + label: Problem Description + description: What's wrong or missing? + placeholder: The current documentation says..., but it should... + validations: + required: true + + - type: textarea + id: suggestion + attributes: + label: Suggested Improvement + description: How should this be improved? + placeholder: I suggest adding/changing... + + - type: textarea + id: context + attributes: + label: Additional Context + description: Any other context (audience perspective, use case, etc.) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..cfba6195 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,75 @@ +name: ✨ Feature Request +description: Suggest a new feature or enhancement for the Tractatus Framework +title: "[Feature]: " +labels: ["enhancement", "needs-triage"] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting a feature! Please fill out the form below. + + - type: textarea + id: problem + attributes: + label: Problem Statement + description: Is your feature request related to a problem? Please describe. + placeholder: I'm frustrated when... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: Describe the solution you'd like to see + placeholder: I would like... + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Describe any alternative solutions or features you've considered + + - type: dropdown + id: component + attributes: + label: Component + description: Which component would this feature affect? + options: + - BoundaryEnforcer + - CrossReferenceValidator + - ContextPressureMonitor + - InstructionPersistenceClassifier + - MetacognitiveVerifier + - PluralisticDeliberationOrchestrator + - Website/Documentation + - New Component + - Other + validations: + required: true + + - type: dropdown + id: values-impact + attributes: + label: Values Impact + description: Does this feature involve values decisions or governance boundaries? + options: + - "No - Technical/operational only" + - "Yes - May involve values decisions" + - "Unsure" + validations: + required: true + + - type: textarea + id: use-case + attributes: + label: Use Case + description: Describe a specific use case or scenario where this feature would be helpful + + - type: textarea + id: additional + attributes: + label: Additional Context + description: Add any other context, mockups, or examples diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 00000000..fda29123 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,35 @@ +name: CI + +on: + push: + branches: [ main, develop ] + pull_request: + branches: [ main, develop ] + +jobs: + lint: + name: Lint Code + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-node@v4 + with: + node-version: 20.x + cache: npm + - run: npm ci + - run: npx eslint . --ext .js --max-warnings 0 + + test: + name: Test + runs-on: ubuntu-latest + strategy: + matrix: + node-version: [18.x, 20.x] + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-node@v4 + with: + node-version: ${{ matrix.node-version }} + cache: npm + - run: npm ci + - run: npm test diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..3cdeb502 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,48 @@ +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 e-mail address, posting via 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 at conduct@agenticgovernance.digital. 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 https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. +Community Impact Guidelines were inspired by Mozilla’s code of conduct enforcement ladder. +For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations. +