diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..be8d0df8 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,25 @@ +# AGENTS.md + +## Cursor Cloud specific instructions + +This is a GitHub organization `.github` repository containing community health files (Markdown docs and a repolinter config). There is no application code, no build step, and no services to run. + +### Repository contents + +- `README.md`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, `SECURITY.md` — community health files +- `profile/README.md` — GitHub organization profile page +- `config/repolinter-ruleset.json` — repolinter rules for enforcing repo standards (MIT license, README, CODEOWNERS) + +### Available dev tools + +- **repolinter**: `repolinter lint --rulesetFile config/repolinter-ruleset.json --dryRun .` — runs repo policy checks using the custom ruleset. Use `--dryRun` to avoid auto-creating fix files (e.g. a `CODEOWNERS` file). The ruleset checks 3 rules: `license-file-is-MIT`, `readme-file-exists`, and `codeowners-file-exists`. +- **markdownlint**: `markdownlint '*.md' 'profile/*.md'` — lints Markdown files (many pre-existing warnings are expected) + +### Known issues + +- `CONTRIBUTING.md` references `script/bootstrap` and `script/cibuild` commands that do not exist in this repository — they are generic placeholder instructions. +- Running `repolinter lint` without `--dryRun` may invoke fix rules (e.g. `codeowners-file-exists` will create `CODEOWNERS` if it is missing, `license-file-is-MIT` will overwrite `LICENSE`). Both files are tracked in this repo, so if a fix run mutates them unintentionally, restore the original with `git restore CODEOWNERS LICENSE` rather than `rm`-ing tracked files. Use `--dryRun` to avoid this. + +### No build, no tests, no dev server + +There are no dependencies, no test suite, no build step, and no dev server to run. Changes are Markdown-only and can be validated visually or with repolinter. diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 00000000..235987c7 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,2 @@ +# Default owners for everything in the repo. +* @marekdkropiewnicki-dotcom diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f301de7d..e293f2ab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,7 +14,7 @@ Please note that this project is released with a Contributor Code of Conduct. By 0. Create a new branch: `git checkout -b my-branch-name` 0. Make your change, add tests, and make sure the tests still pass 0. Push to your fork and submit a pull request -0. Pat your self on the back and wait for your pull request to be reviewed and merged. +0. Pat yourself on the back and wait for your pull request to be reviewed and merged. Here are a few things you can do that will increase the likelihood of your pull request being accepted: diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..485761d2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 marekdkropiewnicki-dotcom + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 3f4e6314..689cdda9 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,6 @@ *Community health files for the [@GitHub](https://github.com/github) organization* -For more information, please see the article on [creating a default community health file for your organization](https://help.github.com/en/articles/creating-a-default-community-health-file-for-your-organization). +For more information, please see the article on [creating a default community health file for your organization](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file). + + diff --git a/config/repolinter-ruleset.json b/config/repolinter-ruleset.json index c57e1b87..34c16b22 100644 --- a/config/repolinter-ruleset.json +++ b/config/repolinter-ruleset.json @@ -1,5 +1,5 @@ { - "$schema": "https://raw.githubusercontent.com/prototypicalpro/repolinter/master/rulesets/schema.json", + "$schema": "https://raw.githubusercontent.com/todogroup/repolinter/master/rulesets/schema.json", "version": 2, "axioms": {}, "rules": { @@ -57,12 +57,12 @@ "type": "file-create", "options": { "file": "CODEOWNERS", - "text": { "url": "https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners" } + "text": "* @marekdkropiewnicki-dotcom\n" } }, "policyInfo": "GitHub requires a CODEOWNERS file in all projects. This enables GitHub to contact the maintainers in the event it is necessary.", "policyUrl": "https://github.com/github/open-source/blob/main/policies/release.md" - }, + } }, "formatOptions": { "disclaimer": "🤖*This issue was automatically generated by [repolinter-action](https://github.com/newrelic/repolinter-action), developed by the Open Source and Developer Advocacy team at New Relic.*"