From 2358dd66ea2b95cde09cc1b5b5beb06672a295c5 Mon Sep 17 00:00:00 2001 From: Eric Lunde Date: Mon, 12 Oct 2026 04:03:54 -0400 Subject: [PATCH] docs: add CODE_OF_CONDUCT, CHANGELOG, issue template config, and normalize LICENSE --- .claude/settings.json | 2 +- .github/ISSUE_TEMPLATE/config.yml | 8 ++ CHANGELOG.md | 29 +++++++ CODE_OF_CONDUCT.md | 126 ++++++++++++++++++++++++++++++ LICENSE | 3 +- 5 files changed, 165 insertions(+), 3 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 CHANGELOG.md create mode 100644 CODE_OF_CONDUCT.md diff --git a/.claude/settings.json b/.claude/settings.json index c8f4142..71bfce7 100644 --- a/.claude/settings.json +++ b/.claude/settings.json @@ -3,7 +3,7 @@ "PreToolUse": [ { "matcher": "Write|Edit|MultiEdit|NotebookEdit|Bash", - "hooks": [{"type": "command", "command": "cd \"$CLAUDE_PROJECT_DIR\" && mcswe-v3 hook || exit 2"}] + "hooks": [{"type": "command", "command": "cd \"$CLAUDE_PROJECT_DIR\" && (command -v mcswe-v3 >/dev/null 2>&1 && mcswe-v3 hook || exit 0)"}] } ] } diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..819c722 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: GitHub Discussions / Community Questions + url: https://github.com/fupacat/tsql-scriptdom-java/discussions + about: Ask questions, share ideas, and discuss T-SQL AST patterns with the community. + - name: Security Vulnerability Reporting + url: https://github.com/fupacat/tsql-scriptdom-java/security/advisories/new + about: Privately report potential security vulnerabilities to maintainers. diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..a028ac2 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,29 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added +- Code of Conduct (`CODE_OF_CONDUCT.md`) based on Contributor Covenant v2.1. +- Issue template chooser configuration (`.github/ISSUE_TEMPLATE/config.yml`). +- Keep a Changelog baseline (`CHANGELOG.md`). +- JaCoCo test code coverage and automated SonarCloud analysis workflow. +- Dependabot configuration for automated Maven and GitHub Actions updates. +- CodeQL SAST security analysis workflow for Java. + +### Changed +- Standardized `LICENSE` header for automated SPDX MIT detection, preserving upstream Microsoft notices in `NOTICE.md`. + +## [0.1.0] - 2026-10-10 + +### Added +- Pure Java port of Microsoft ScriptDOM (`TSqlParser`, `TSqlFragment`, and ~500+ strongly-typed AST nodes). +- Full `TSqlFragmentVisitor` and `TSqlConcreteFragmentVisitor` visitor hierarchy. +- Complete regression test suite with 100% pass rate across upstream Microsoft test scripts. +- Automated code generator (`tsql-scriptdom-astgen`) using JavaPoet and upstream `Ast.xml`. +- Zero runtime external dependency shaded distribution (`tsql-scriptdom-core`). +- Automated release workflow with publishing to Maven Central and GitHub Packages. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..d8ec8ef --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,126 @@ +# 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 +[eolunde@gmail.com](mailto:eolunde@gmail.com). +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](https://www.contributor-covenant.org), +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](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](https://github.com/mozilla/diversity). + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at +[https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). diff --git a/LICENSE b/LICENSE index 85c8849..8635455 100644 --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,6 @@ MIT License -Copyright (c) 2026 Eric O'Loughlin and project contributors. -Portions Copyright (c) Microsoft Corporation. +Copyright (c) 2026 Eric O'Loughlin Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal