Skip to content

Commit 7d30b02

Browse files
authored
docs: add security and governance policies (#11)
* docs: fix readme links * docs: remove legacy docs * docs: add new policies * docs: fix markdown lints
1 parent ba1c4b3 commit 7d30b02

File tree

13 files changed

+67
-246
lines changed

13 files changed

+67
-246
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ and [submit a pull-request](https://github.com/ArwynFr/dotnet-integration-testin
2222

2323
Merging a pull request requires:
2424

25+
- dotnet test passes
2526
- dotnet format passes
2627
- dotnet roslynator analyze passes
2728
- dotnet oudated passes

.github/GOVERNANCE.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Project governance policy
2+
3+
## Roles
4+
5+
### Maintainer
6+
7+
The maintainer administrates the repository and is responsible for the overall
8+
health of the product.
9+
10+
Persons in role: [ArwynFr](https://github.com/ArwynFr)
11+
12+
### Moderators
13+
14+
Moderators have multiple responsabilities:
15+
16+
- They triage issues
17+
- They review pull-requests
18+
19+
Persons in role: _none_
20+
21+
### Contributors
22+
23+
Contributors are people that write code of the library.
24+
This library accepts contributions from anyone, but contributons are screened
25+
by the moderators and the maintainer.
26+
27+
[Persons in role](https://github.com/ArwynFr/dotnet-integration-testing/graphs/contributors)
28+
29+
## Applications and departures
30+
31+
The maintainer can discharge moderators:
32+
33+
- After one month without contact
34+
- In case of policy violation
35+
36+
The maintainer can appoint new moderators after discussion with other moderators.
37+
38+
_This project is not currently appointing new moderators._

.github/README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
This library provides utility classes for writing integration tests in
44
dotnet using `XUnit` and `WebApplicationFactory`.
55

6-
![Nuget.org](https://img.shields.io/nuget/v/ArwynFr.IntegrationTesting?style=for-the-badge)
7-
![Nuget.org](https://img.shields.io/nuget/dt/ArwynFr.IntegrationTesting?style=for-the-badge)
8-
![GitHub
9-
License](https://img.shields.io/github/license/ArwynFr/dotnet-integration-testing?style=for-the-badge)
6+
[![Nuget.org](https://img.shields.io/nuget/v/ArwynFr.IntegrationTesting?style=for-the-badge)](https://www.nuget.org/packages/ArwynFr.IntegrationTesting/)
7+
[![Nuget.org](https://img.shields.io/nuget/dt/ArwynFr.IntegrationTesting?style=for-the-badge)](https://www.nuget.org/packages/ArwynFr.IntegrationTesting/)
8+
[![GitHub
9+
License](https://img.shields.io/github/license/ArwynFr/dotnet-integration-testing?style=for-the-badge)](https://github.com/ArwynFr/dotnet-integration-testing#MIT-1-ov-file)
1010

1111
## Installation
1212

@@ -15,7 +15,7 @@ License](https://img.shields.io/github/license/ArwynFr/dotnet-integration-testin
1515
## Usage
1616

1717
Read [advanced usage
18-
documentation](https://github.com/ArwynFr/dotnet-integration-testing/blob/main/.github/USAGE.adoc)
18+
documentation](https://github.com/ArwynFr/dotnet-integration-testing/blob/main/.github/USAGE.md)
1919
for further details.
2020

2121
By default, the lib redirects the tested application logs to XUnit
@@ -80,6 +80,8 @@ TBD
8080

8181
**Disclose vulnerability:**
8282
Please [create a new security advisory on GitHub](https://github.com/ArwynFr/dotnet-integration-testing/security/advisories)
83+
\
84+
[Read our security policy](https://github.com/ArwynFr/dotnet-integration-testing/blob/main/.github/SECURITY.md)
8385

8486
**Report malfunctions:**
8587
[Please create a new issue on GitHub](https://github.com/ArwynFr/dotnet-integration-testing/issues/new/choose)
@@ -92,3 +94,8 @@ Please [fork the repository](https://github.com/ArwynFr/dotnet-integration-testi
9294
and [submit a pull-request](https://github.com/ArwynFr/dotnet-integration-testing/compare)
9395
\
9496
[Read our definition of done in contributing guidelines](https://github.com/ArwynFr/dotnet-integration-testing/blob/main/.github/CONTRIBUTING.md)
97+
98+
**Moderate contributions:**
99+
This project is not currently appointing new moderators.
100+
\
101+
[Read our governance policy](https://github.com/ArwynFr/dotnet-integration-testing/blob/main/.github/GOVERNANCE.md)

.github/SECURITY.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Security policy
2+
3+
## Supported version
4+
5+
The latest version of the library is the only one suported.
6+
Please update to the latest version before reporting a vulnerability.
7+
8+
## Bug bounties
9+
10+
There is no bug bounty program in place in our organization.
11+
We will not deliver any bounty for reported bugs or vulnerabilities.
12+
13+
## Report vulnerabilities
14+
15+
Please [create a new security advisory on GitHub](https://github.com/ArwynFr/dotnet-integration-testing/security/advisories).

OSSMETADATA

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
osslifecycle=active

docs/CONTRIBUTING-dod.adoc

Lines changed: 0 additions & 6 deletions
This file was deleted.

docs/CONTRIBUTING-table.adoc

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/CONTRIBUTING.adoc

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/Make.ps1

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/README.adoc

Lines changed: 0 additions & 31 deletions
This file was deleted.

0 commit comments

Comments
 (0)