From 737f37406218d10afa9ece93883396bdf53ab8d6 Mon Sep 17 00:00:00 2001 From: Kengo TODA Date: Wed, 8 Dec 2021 12:26:00 +0800 Subject: [PATCH 1/4] docs: make the governance policy for this repo clear --- .github/CONTRIBUTING.md | 5 +++++ GOVERNANCE.md | 29 +++++++++++++++++++++++++++++ README.md | 2 +- 3 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 GOVERNANCE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 32acda4b4f3..4b3fe4ad26d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -14,3 +14,8 @@ Just three steps to follow: ## Before you propose new rules Please consider to follow the same points with ***Before reporting problem in detectors***. + +## Before you submit a pull request + +1. Run `./gradlew spotlessApply build smoketest` in your local to verify your change. +2. Make sure you updated the `CHANGELOG.md` accordingly. Detailed requirements are explained at the beginning of the changelog. diff --git a/GOVERNANCE.md b/GOVERNANCE.md new file mode 100644 index 00000000000..70a0fd6bdd0 --- /dev/null +++ b/GOVERNANCE.md @@ -0,0 +1,29 @@ +# Governance Policy + +This document provides the governance policy for the SpotBugs Project. + +## SpotBugs Core Term + +The SpotBugs Core Team maintain the spotbugs/spotbugs GitHub repository. + +The GitHub team for SpotBugs Team is `@spotbugs/core-devs`. Members of the SpotBugs Core Team have write access to the repository. + +## How we propose changes + +Both SpotBugs Core Team and SpotBugs user can propose changes to the SpotBugs project via GitHub pull requests. Refer to `.github/CONTRIBUTING.md` to know more detailed requirements for your proposal. + +Once a pull request got two approvals from members of SpotBugs Core Team, pull request will be merged and shipped in the next release. Approver should not be the same to authors of the change. + +If pull request cannot get enough approvals during 30 days, it will be labeled as stale pull request. Stale pull requests will be closed after another 30 days. + +## Issue Management Policy + +Both SpotBugs Core Team and SpotBugs user can create issue at GitHub Issues. Refer to `.github/CONTRIBUTING.md` to know more detailed requirements for your proposal. + +If issue has no updated for 30 days from when it is labeled as 'need info', SpotBugs Core Team will closed it. + +## Nomination to the SpotBugs Core Team + +Members of SpotBugs Core Team can nominate new members. The nomination process is held at [GitHub Team Discussions](https://docs.github.com/en/organizations/collaborating-with-your-team/about-team-discussions). + +We set no clear condition to nominate, but usually nominate from active contributors. diff --git a/README.md b/README.md index 3601c4e4311..61d67b219f1 100644 --- a/README.md +++ b/README.md @@ -33,4 +33,4 @@ SpotBugs can be used standalone and through several integrations, including: * [IntelliJ IDEA](https://github.com/JetBrains/spotbugs-intellij-plugin) # Questions? -You can contact us using [our general purpose mailing list](https://github.com/spotbugs/discuss/issues?q=). +You can contact us using [GitHub Discussions](https://github.com/spotbugs/spotbugs/discussions). From 3e8d8a4c80411a1dfd53b76d0aa0f887caa93dc4 Mon Sep 17 00:00:00 2001 From: Kengo TODA Date: Thu, 9 Dec 2021 09:52:21 +0800 Subject: [PATCH 2/4] docs: reflect a review from ThrawnCA https://github.com/spotbugs/spotbugs/pull/1856/files#r765329718 --- GOVERNANCE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 70a0fd6bdd0..e87b6ef5091 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -12,7 +12,7 @@ The GitHub team for SpotBugs Team is `@spotbugs/core-devs`. Members of the SpotB Both SpotBugs Core Team and SpotBugs user can propose changes to the SpotBugs project via GitHub pull requests. Refer to `.github/CONTRIBUTING.md` to know more detailed requirements for your proposal. -Once a pull request got two approvals from members of SpotBugs Core Team, pull request will be merged and shipped in the next release. Approver should not be the same to authors of the change. +Once a pull request gets two approvals from members of SpotBugs Core Team, pull request will be merged and shipped in the next release. Approver should not be the same as the author(s) of the change. If pull request cannot get enough approvals during 30 days, it will be labeled as stale pull request. Stale pull requests will be closed after another 30 days. From fb3cdb6f43515cc239310b9660563d50c7e77788 Mon Sep 17 00:00:00 2001 From: Kengo TODA Date: Sat, 11 Dec 2021 16:08:23 +0800 Subject: [PATCH 3/4] docs: update GOVERNANCE.md --- GOVERNANCE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index e87b6ef5091..5531f9fb7ee 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -12,7 +12,7 @@ The GitHub team for SpotBugs Team is `@spotbugs/core-devs`. Members of the SpotB Both SpotBugs Core Team and SpotBugs user can propose changes to the SpotBugs project via GitHub pull requests. Refer to `.github/CONTRIBUTING.md` to know more detailed requirements for your proposal. -Once a pull request gets two approvals from members of SpotBugs Core Team, pull request will be merged and shipped in the next release. Approver should not be the same as the author(s) of the change. +Once a pull request gets two approvals from members of SpotBugs Core Team, pull request will be merged and shipped in the next release. If pull request cannot get enough approvals during 30 days, it will be labeled as stale pull request. Stale pull requests will be closed after another 30 days. From 56d0d61a9cbe96f3be0cc0ebf916ef1c7536e4eb Mon Sep 17 00:00:00 2001 From: Kengo TODA Date: Wed, 22 Dec 2021 10:24:20 +0800 Subject: [PATCH 4/4] docs: correct sentences to tell meaning without making readers confused --- GOVERNANCE.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 5531f9fb7ee..3742fae1879 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -2,9 +2,9 @@ This document provides the governance policy for the SpotBugs Project. -## SpotBugs Core Term +## SpotBugs Core Team -The SpotBugs Core Team maintain the spotbugs/spotbugs GitHub repository. +The SpotBugs Core Team maintains the spotbugs/spotbugs GitHub repository. The GitHub team for SpotBugs Team is `@spotbugs/core-devs`. Members of the SpotBugs Core Team have write access to the repository. @@ -12,18 +12,18 @@ The GitHub team for SpotBugs Team is `@spotbugs/core-devs`. Members of the SpotB Both SpotBugs Core Team and SpotBugs user can propose changes to the SpotBugs project via GitHub pull requests. Refer to `.github/CONTRIBUTING.md` to know more detailed requirements for your proposal. -Once a pull request gets two approvals from members of SpotBugs Core Team, pull request will be merged and shipped in the next release. +Once a pull request gets two approvals from members of SpotBugs Core Team, pull request can be merged and shipped in the next release. -If pull request cannot get enough approvals during 30 days, it will be labeled as stale pull request. Stale pull requests will be closed after another 30 days. +If pull request cannot get enough approvals during 30 days, it can be labeled as stale pull request. Stale pull requests can be closed after another 30 days. ## Issue Management Policy -Both SpotBugs Core Team and SpotBugs user can create issue at GitHub Issues. Refer to `.github/CONTRIBUTING.md` to know more detailed requirements for your proposal. +Both SpotBugs Core Team and SpotBugs users can create issues at GitHub Issues. Refer to `.github/CONTRIBUTING.md` to get more detailed requirements for your proposal. -If issue has no updated for 30 days from when it is labeled as 'need info', SpotBugs Core Team will closed it. +If issue is not updated for 30 days from when it was labeled as 'need info', SpotBugs Core Team can close it. ## Nomination to the SpotBugs Core Team Members of SpotBugs Core Team can nominate new members. The nomination process is held at [GitHub Team Discussions](https://docs.github.com/en/organizations/collaborating-with-your-team/about-team-discussions). -We set no clear condition to nominate, but usually nominate from active contributors. +We set no clear condition for nomination, but usually nominate from active contributors.