You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/policies/OpenAPI.NET-branch-protection.yml
+36Lines changed: 36 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -81,3 +81,39 @@ configuration:
81
81
# Restrict who can dismiss pull request reviews. boolean
82
82
restrictsReviewDismissals: false
83
83
84
+
- branchNamePattern: support/v2
85
+
# This branch pattern applies to the following branches as of approximately 02/27/2025 15:28:20:
86
+
# support/v1
87
+
88
+
# Specifies whether this branch can be deleted. boolean
89
+
allowsDeletions: false
90
+
# Specifies whether forced pushes are allowed on this branch. boolean
91
+
allowsForcePushes: false
92
+
# Specifies whether new commits pushed to the matching branches dismiss pull request review approvals. boolean
93
+
dismissStaleReviews: true
94
+
# Specifies whether admins can overwrite branch protection. boolean
95
+
isAdminEnforced: true
96
+
# Indicates whether "Require a pull request before merging" is enabled. boolean
97
+
requiresPullRequestBeforeMerging: true
98
+
# Specifies the number of pull request reviews before merging. int (0-6). Should be null/empty if PRs are not required
99
+
requiredApprovingReviewsCount: 1
100
+
# Require review from Code Owners. Requires requiredApprovingReviewsCount. boolean
101
+
requireCodeOwnersReview: true
102
+
# Are commits required to be signed. boolean. TODO: all contributors must have commit signing on local machines.
103
+
requiresCommitSignatures: false
104
+
# Are conversations required to be resolved before merging? boolean
105
+
requiresConversationResolution: true
106
+
# Are merge commits prohibited from being pushed to this branch. boolean
107
+
requiresLinearHistory: false
108
+
# Required status checks to pass before merging. Values can be any string, but if the value does not correspond to any existing status check, the status check will be stuck on pending for status since nothing exists to push an actual status
109
+
requiredStatusChecks:
110
+
- license/cla
111
+
- CodeQL
112
+
- Continuous Integration
113
+
# Require branches to be up to date before merging. boolean
114
+
requiresStrictStatusChecks: false
115
+
# Indicates whether there are restrictions on who can push. boolean. Should be set with whoCanPush.
116
+
restrictsPushes: false
117
+
# Restrict who can dismiss pull request reviews. boolean
Please fill out the template below to help us review your pull request.
6
+
-->
7
+
8
+
## Description
9
+
<!-- Provide a brief description of your changes -->
10
+
11
+
## Type of Change
12
+
<!-- Mark the relevant option with an "x" -->
13
+
-[ ] Bug fix (non-breaking change which fixes an issue)
14
+
-[ ] New feature (non-breaking change which adds functionality)
15
+
-[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
16
+
-[ ] Documentation update
17
+
-[ ] Other (please describe):
18
+
19
+
## Related Issue(s)
20
+
<!-- Link to any related issues using "Fixes #123" or "Closes #123" -->
21
+
22
+
## Changes Made
23
+
<!-- List the main changes made in this PR -->
24
+
-
25
+
-
26
+
-
27
+
28
+
## Testing
29
+
<!-- Describe how you tested your changes -->
30
+
-[ ] Unit tests added/updated
31
+
-[ ] Integration tests added/updated
32
+
-[ ] Manual testing performed
33
+
-[ ] All existing tests pass
34
+
35
+
## Checklist
36
+
<!-- Mark completed items with an "x" -->
37
+
-[ ] My code follows the code style of this project
38
+
-[ ] I have performed a self-review of my own code
39
+
-[ ] I have made corresponding changes to the documentation
40
+
-[ ] My changes generate no new warnings
41
+
-[ ] I have added tests that prove my fix is effective or that my feature works
42
+
-[ ] New and existing unit tests pass locally with my changes
43
+
44
+
## Versions applicability
45
+
46
+
-[ ] My change applies to the version 1.X of the library, if so PR link:
47
+
-[ ] My change applies to the version 2.X of the library, if so PR link:
48
+
-[ ] My change applies to the version 3.X of the library, if so PR link:
49
+
-[ ] I have evaluated the applicability of my change against the other versions above.
50
+
51
+
See [the contributing guidelines](https://github.com/microsoft/OpenAPI.NET/blob/main/CONTRIBUTING.md) for more information about how patches are applied across multiple versions.
52
+
53
+
## Additional Notes
54
+
<!-- Add any additional information that reviewers should know -->
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+25-1Lines changed: 25 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,31 @@ The best way to get started with a contribution is to start a dialog with the ow
20
20
21
21
## Submit pull requests for bug fixes and features
22
22
23
-
Feel free to submit a pull request with a linked issue against the __main__ branch. The main branch will be updated frequently.
23
+
Feel free to submit a pull request with a linked issue.
24
+
25
+
### Branches and support policy
26
+
27
+
Because one major consumer of these libraries is ASP.net, the support policy of this repository is aligned with [dotnet support policy](https://dotnet.microsoft.com/platform/support/policy/dotnet-core#lifecycle).
28
+
29
+
The following table outlines the mapping between package major versions, dotnet versions, and which contributions are accepted. As a consumer, make sure the version of this library your application is using is aligned with the version of ASP.net described in the table below.
30
+
31
+
| Major version | Branch | Supported ASP.NET versions | Supported OpenAPI versions | Changes provided by Microsoft | Accepted contributions | End of support date |
| 2.X | support/v2 | = 10 * | 2.0, 3.0, 3.1 | security and bugfixes | security and bugfixes | net 10 (Nov 2028) * |
35
+
| 3.X | main | not available | 2.0, 3.0, 3.1, 3.2 | security, bugfixes and feature improvements | security, bugfixes and feature improvements | TBD **|
36
+
37
+
> Notes:
38
+
>
39
+
> * This assumes that NET 11 and above will adopt version 3 or above of this library, otherwise, it'd expand the support date for version 2 of this library.
40
+
> ** This will be conditioned by new releases of OpenAPI, this library, asp.net and asp.net's adoptions of new versions of this library.
41
+
42
+
### Multi-versions requirement for contributions
43
+
44
+
When contributing to the library, start by making a contribution to the main branch first, or the uppermost version it applies to. During the review process you'll be asked to demonstrate your contribution cannot apply to prior versions or to port your contribution to the branches for prior versions before the initial pull request can get merged.
45
+
46
+
This approach helps maintain a similar behavior across all versions under active support.
47
+
24
48
## Commit message format
25
49
26
50
To support our automated release process, pull requests are required to follow the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/)
0 commit comments