diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..1d159d6 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,7 @@ +# Every path is owned by the maintainer, so each pull request — including the ones +# Dependabot opens — automatically requests a review rather than sitting unnoticed. +# +# This is the GitHub account handle, which is unchanged. The publisher's DISPLAY +# name is WinterNova5; every id, URL, and handle still reads ElecTreeFrying, and +# that is correct — do not "fix" it here. +* @ElecTreeFrying diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..8a8686f --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,130 @@ +# 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 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 +**electreefrying.git@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][homepage], +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][mozilla]. + +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. + +[homepage]: https://www.contributor-covenant.org +[mozilla]: https://github.com/mozilla/diversity diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..8ef419f --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,99 @@ +# Contributing + +Thanks for wanting to help. Bug reports, feature requests, and pull requests are all +welcome — **new data generators especially.** Breadth is the whole value of this +extension, and a new generator is one of the easiest first contributions here. + +## Before you start + +- **Open an issue first** for anything structural. A new generator usually does not + need one; a new *setting* or a change to how insertion works does. +- Read [`SPEC.md`](../SPEC.md). It is the user-facing contract — every command, every + setting, every catalog row. If your change alters behavior, **it lands there too**. + +## Setup + +```bash +npm install +``` + +Press F5 → **Run Extension** to launch an Extension Development Host. + +## The commands that matter + +```bash +npm run compile # check-types + lint + esbuild (node AND web) ← "green" +npm run watch # incremental dev build +npm run lint # eslint src +npm run package # production build; what vscode:prepublish runs + +# Headless — the vscode-free areas, no Extension Host needed +npm run compile-tests && npx mocha "out/test/{quote,config,catalog,engine,format,record,prompted,custom,randomize}/*.test.js" + +# Full suite — required for commands/ and extension.test.ts +npm test +``` + +Do not widen that mocha glob to `**`: `extension.test.ts` and `commands/` import +`vscode` and fail under plain node. And if headless results look stale after renaming +or deleting a test, `rm -rf out` — orphaned compiled tests linger there. + +## Adding a generator — the common case + +1. **`src/catalog.ts`** — add a `{ id, label, group, generate }` entry. It shows up in + the Quick Pick automatically. +2. **`package.json`** → `contributes.commands` — add + `{ "command": "insertRandomText.", "title": "Insert Random: