Skip to content

dev: update from main #4498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Mar 28, 2025
10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
blank_issues_enabled: false

# The local issue filing links are included in "contact_links" because
# GitHub's regular issue template mechanism forces the local issue
# links to be first in the list, when we want them to be last so
# visitors can be routed to other repos when appropriate.
contact_links:
- name: Have a question about using OpenAPI?
url: https://communityinviter.com/apps/open-api/openapi
@@ -17,12 +13,6 @@ contact_links:
- name: Want to suggest more how-to documentation and examples?
url: https://github.com/OAI/learn.openapis.org/issues/new
about: Please open an issue on our learning site!
- name: Want to add to the registries at spec.openapis.org/registry ?
url: https://github.com/OAI/OpenAPI-Specification/issues/new
about: Please open an issue in this repository!
- name: Want to report an error in the specification?
url: https://github.com/OAI/OpenAPI-Specification/issues/new
about: Please open an issue in this repository!
- name: Want to request a new feature in the specification?
url: https://github.com/OAI/OpenAPI-Specification/discussions/new?category=enhancements
about: Please start a discussion in this repository!
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/registry_feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Contribute to the registries at spec.openapis.org/registry
about: Add a new registry entry, or edit an existing one
title: 'Registry: ...'
labels: registries
assignees: ''

---

**Which registry do you want to contribute to**
- [ ] [Alternative Schema Type Registry](https://spec.openapis.org/registry/alternative-schema)
- [ ] [Draft Features Registry](https://spec.openapis.org/registry/draft-feature)
- [ ] [Specification Extension Registry](https://spec.openapis.org/registry/extension)
- [ ] [Format Registry](https://spec.openapis.org/registry/format)
- [ ] [Extension Namespace Registry](https://spec.openapis.org/registry/namespace)
- [ ] [Tag Kind Registry](https://spec.openapis.org/registry/tag-kind)

**Describe your contribution**
A clear and concise description of what you want to add or change.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: Bug report
name: Report an error in the specification
about: Create a report to help us improve the specification
title: 'vX.Y: ...'
labels: ''
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -14,7 +14,7 @@ present on the main branch, only on the development branches).
Note that we do not accept changes to published specifications.
-->

Tick one of the following options:
<!-- Tick one of the following options: -->

- [ ] schema changes are included in this pull request
- [ ] schema changes are needed for this pull request but not done yet
6 changes: 6 additions & 0 deletions style-guide.md
Original file line number Diff line number Diff line change
@@ -22,6 +22,12 @@ The following additional rules should be followed but currently are not enforced
10. Use `<span id="thing"></span>` for link anchors. The `<a name="thing"></a>` format has been deprecated.
11. Headings use [title case](https://en.wikipedia.org/wiki/Title_case) and are followed by a blank line.
12. Do not use [RFC2119 key words (MUST, MAY, ...)](https://datatracker.ietf.org/doc/html/rfc2119) in "Examples" sections or when explaining examples, and state requirements only in sections that are clearly normative.
13. Bullet lists and punctuation:
- If a bullet list item is a complete sentence or paragraph, start it with an uppercase letter and end it with a period.
- If a bullet list item is a word or short phrase, start it with an uppercase letter and do not end it with a punctuation character.
- If a bullet list item completes a stem sentence immediately preceding the bullet list, start it with a lowercase letter and end it with a period.
- Use a consistent bullet list item style for each bullet list.
- If in doubt which style to use for a new bullet list, look for similar lists in the same section or nearby sections and choose the same style.

Plus some suggestions, rather than rules: