Skip to content

Commit 1c4214a

Browse files
authored
Merge pull request #4498 from OAI/main
dev: update from main
2 parents 73f2e64 + beb56e0 commit 1c4214a

File tree

5 files changed

+33
-12
lines changed

5 files changed

+33
-12
lines changed

.github/ISSUE_TEMPLATE/config.yml

-10
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
blank_issues_enabled: false
22

3-
# The local issue filing links are included in "contact_links" because
4-
# GitHub's regular issue template mechanism forces the local issue
5-
# links to be first in the list, when we want them to be last so
6-
# visitors can be routed to other repos when appropriate.
73
contact_links:
84
- name: Have a question about using OpenAPI?
95
url: https://communityinviter.com/apps/open-api/openapi
@@ -17,12 +13,6 @@ contact_links:
1713
- name: Want to suggest more how-to documentation and examples?
1814
url: https://github.com/OAI/learn.openapis.org/issues/new
1915
about: Please open an issue on our learning site!
20-
- name: Want to add to the registries at spec.openapis.org/registry ?
21-
url: https://github.com/OAI/OpenAPI-Specification/issues/new
22-
about: Please open an issue in this repository!
23-
- name: Want to report an error in the specification?
24-
url: https://github.com/OAI/OpenAPI-Specification/issues/new
25-
about: Please open an issue in this repository!
2616
- name: Want to request a new feature in the specification?
2717
url: https://github.com/OAI/OpenAPI-Specification/discussions/new?category=enhancements
2818
about: Please start a discussion in this repository!
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Contribute to the registries at spec.openapis.org/registry
3+
about: Add a new registry entry, or edit an existing one
4+
title: 'Registry: ...'
5+
labels: registries
6+
assignees: ''
7+
8+
---
9+
10+
**Which registry do you want to contribute to**
11+
- [ ] [Alternative Schema Type Registry](https://spec.openapis.org/registry/alternative-schema)
12+
- [ ] [Draft Features Registry](https://spec.openapis.org/registry/draft-feature)
13+
- [ ] [Specification Extension Registry](https://spec.openapis.org/registry/extension)
14+
- [ ] [Format Registry](https://spec.openapis.org/registry/format)
15+
- [ ] [Extension Namespace Registry](https://spec.openapis.org/registry/namespace)
16+
- [ ] [Tag Kind Registry](https://spec.openapis.org/registry/tag-kind)
17+
18+
**Describe your contribution**
19+
A clear and concise description of what you want to add or change.
20+
21+
**Describe alternatives you've considered**
22+
A clear and concise description of any alternative solutions or features you've considered.
23+
24+
**Additional context**
25+
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/bug_report.md renamed to .github/ISSUE_TEMPLATE/spec_bug_report.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: Bug report
2+
name: Report an error in the specification
33
about: Create a report to help us improve the specification
44
title: 'vX.Y: ...'
55
labels: ''

.github/pull_request_template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ present on the main branch, only on the development branches).
1414
Note that we do not accept changes to published specifications.
1515
-->
1616

17-
Tick one of the following options:
17+
<!-- Tick one of the following options: -->
1818

1919
- [ ] schema changes are included in this pull request
2020
- [ ] schema changes are needed for this pull request but not done yet

style-guide.md

+6
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ The following additional rules should be followed but currently are not enforced
2222
10. Use `<span id="thing"></span>` for link anchors. The `<a name="thing"></a>` format has been deprecated.
2323
11. Headings use [title case](https://en.wikipedia.org/wiki/Title_case) and are followed by a blank line.
2424
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.
25+
13. Bullet lists and punctuation:
26+
- If a bullet list item is a complete sentence or paragraph, start it with an uppercase letter and end it with a period.
27+
- 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.
28+
- 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.
29+
- Use a consistent bullet list item style for each bullet list.
30+
- 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.
2531

2632
Plus some suggestions, rather than rules:
2733

0 commit comments

Comments
 (0)