Skip to content

Commit d67ae20

Browse files
tkirda-bisonclaude
andcommitted
chore: contributor onboarding (templates, dependabot, README security note)
- .github/ISSUE_TEMPLATE/bug_report.md — requires plugin version, jQuery version, full options object, repro steps. Aims to prevent the "vague report, ghost reporter" pattern (#862) by forcing the info the maintainer otherwise has to ask for after the fact. - .github/ISSUE_TEMPLATE/feature_request.md — sketches API proposal, alternatives considered, prior art. - .github/ISSUE_TEMPLATE/config.yml — disables blank issues; routes security reports to Private Vulnerability Reporting. - .github/PULL_REQUEST_TEMPLATE.md — Summary / Test plan / Breaking changes checklist; references the local CI commands. - .github/dependabot.yml — weekly grouped dev-dep PR (`chore(deps): ...`) and a separate GitHub Actions update channel (`ci(deps): ...`). Open-PR caps at 5/3. - readme.md — new "Security" section signposting SECURITY.md and the Private Vulnerability Reporting form. Previously these existed but nothing in the README pointed at them. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 592db81 commit d67ae20

6 files changed

Lines changed: 155 additions & 0 deletions

File tree

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
name: Bug report
3+
about: A reproducible bug in the plugin
4+
title: ""
5+
labels: bug
6+
---
7+
8+
<!--
9+
Bug reports without a minimal reproduction are very hard to act on and
10+
will usually be closed asking for more info. Please fill in every section.
11+
-->
12+
13+
## What happened
14+
15+
<!-- One or two sentences describing the actual behavior you observed. -->
16+
17+
## What you expected to happen
18+
19+
<!-- One or two sentences describing what should have happened instead. -->
20+
21+
## Versions
22+
23+
- `devbridge-autocomplete`:
24+
- `jquery`:
25+
- Browser + OS:
26+
27+
## Autocomplete options
28+
29+
<!--
30+
Paste the FULL options object you pass to `.autocomplete(...)` or
31+
`.devbridgeAutocomplete(...)`. Replace any secrets (URLs, API keys)
32+
with placeholders.
33+
-->
34+
35+
```js
36+
$('#example').devbridgeAutocomplete({
37+
// ...
38+
});
39+
```
40+
41+
## Steps to reproduce
42+
43+
1.
44+
2.
45+
3.
46+
47+
## Minimal reproduction
48+
49+
<!--
50+
Strongly preferred: a CodePen / JSFiddle / GitHub repo with the smallest
51+
possible setup that demonstrates the bug. Without one, the maintainer
52+
has to guess at your DOM, your callbacks, and your data shape.
53+
-->

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Security vulnerability
4+
url: https://github.com/devbridge/jQuery-Autocomplete/security/advisories/new
5+
about: Please report vulnerabilities privately via GitHub Security Advisories, not as a public issue.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Feature request
3+
about: Propose a new option, callback, or behavior
4+
title: ""
5+
labels: enhancement
6+
---
7+
8+
## The problem
9+
10+
<!-- What can't you do today, or what's awkward? Concrete use case preferred. -->
11+
12+
## Proposed API
13+
14+
<!--
15+
Sketch the option name, callback signature, or method you'd want.
16+
Match the style of existing options in the readme's tables.
17+
-->
18+
19+
```js
20+
$('#example').devbridgeAutocomplete({
21+
yourNewOption: ...,
22+
});
23+
```
24+
25+
## Alternatives considered
26+
27+
<!-- Have you worked around it with existing options or formatResult/transformResult/lookupFilter? -->
28+
29+
## Additional context
30+
31+
<!-- Links to similar features in other libraries, references, etc. -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!--
2+
Thanks for the PR! A short note on each section keeps reviews fast.
3+
Delete sections that don't apply.
4+
-->
5+
6+
## Summary
7+
8+
<!-- What does this change and why? One paragraph. Reference any related issue with "Closes #123". -->
9+
10+
## Test plan
11+
12+
<!--
13+
How did you verify this works?
14+
- For bug fixes: did you add a regression test?
15+
- For new options: are there specs covering the happy path + at least one edge case?
16+
- For docs/build changes: how did you smoke-test?
17+
-->
18+
19+
- [ ] `npm test` passes locally
20+
- [ ] `npm run lint && npm run format:check && npm run typecheck && npm run build` all green
21+
- [ ] If this changes a documented API, `readme.md` is updated to match
22+
23+
## Breaking changes
24+
25+
<!-- Anything that requires a major-version bump? Type-system narrowing, removed options, changed defaults, etc. -->
26+
27+
None / List them here.

.github/dependabot.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
version: 2
2+
updates:
3+
# Dev-dependencies: weekly grouped PR. Production has only `jquery` as a
4+
# peer dep (and no runtime deps); production updates are handled per release.
5+
- package-ecosystem: npm
6+
directory: /
7+
schedule:
8+
interval: weekly
9+
day: monday
10+
time: "06:00"
11+
open-pull-requests-limit: 5
12+
groups:
13+
dev-dependencies:
14+
dependency-type: development
15+
update-types:
16+
- minor
17+
- patch
18+
commit-message:
19+
prefix: "chore(deps)"
20+
21+
# GitHub Actions used in workflows (CodeQL, CI, release). Pin updates so we
22+
# don't drift behind a security-relevant action.
23+
- package-ecosystem: github-actions
24+
directory: /
25+
schedule:
26+
interval: weekly
27+
day: monday
28+
time: "06:00"
29+
open-pull-requests-limit: 3
30+
commit-message:
31+
prefix: "ci(deps)"

readme.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,6 +280,14 @@ the alias:
280280
$('.autocomplete').devbridgeAutocomplete({ ... });
281281
```
282282

283+
## Security
284+
285+
To report a vulnerability, **please do not open a public GitHub issue.**
286+
Use GitHub's [Private Vulnerability Reporting](https://github.com/devbridge/jQuery-Autocomplete/security/advisories/new)
287+
form on this repository — it routes the report directly to the
288+
maintainers. Full policy and supported-version table:
289+
[SECURITY.md](https://github.com/devbridge/jQuery-Autocomplete/blob/master/SECURITY.md).
290+
283291
## License
284292

285293
Ajax Autocomplete for jQuery is freely distributable under the terms of an

0 commit comments

Comments
 (0)