diff --git a/.github/issue_template.md b/.github/issue_template.md index 18e06775e..498d7209a 100644 --- a/.github/issue_template.md +++ b/.github/issue_template.md @@ -1,9 +1,9 @@ - + - + ### Description diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index b74f4182e..820215df4 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,5 +1,5 @@ - + ## PR Description diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 25a3baf0c..4b7c6824d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ # Contributing :+1::tada: First off, thanks for taking the time to contribute! :tada::+1: -Welcome to the discv5 repository! The following is a set of guidelines for contributing to this repo and its packages. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. +Welcome to the discovery repository! The following is a set of guidelines for contributing to this repo and its packages. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. #### Table Of Contents [Code of Conduct](#code-of-conduct) @@ -46,7 +46,7 @@ Before creating bug reports, please check the [before-submitting-a-bug-report](# #### Before Submitting A Bug Report * **Confirm the problem** is reproducible in the latest version of the software * **Check the [Debugging Wiki]**. You might be able to find the cause of the problem and fix things yourself. -* **Perform a [cursory search of project issues](https://github.com/search?q=+is%3Aissue+repo%3APegasysEng/discv5)** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. +* **Perform a [cursory search of project issues](https://github.com/search?q=+is%3Aissue+repo%3APegasysEng/discovery)** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. #### How Do I Submit A (Good) Bug Report? Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Issues should provide the following information by filling in the [issue_template.md](.github/issue_template.md). @@ -85,7 +85,7 @@ Before creating enhancement suggestions, please check the [before-submitting-an- #### Before Submitting An Enhancement Suggestion * **Check the [Debugging Wiki].** You might be able to find the cause of the problem and fix things yourself. -* **Perform a [cursory search of project issues](https://github.com/search?q=+is%3Aissue+repo%3APegasysEng/discv5)** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. +* **Perform a [cursory search of project issues](https://github.com/search?q=+is%3Aissue+repo%3APegasysEng/discovery)** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. #### How Do I Submit A (Good) Enhancement Suggestion? @@ -183,23 +183,23 @@ We have a set of [coding conventions](https://github.com/hyperledger/besu/blob/m | `invalid` | [search][search-label-invalid] | Issues which aren't valid (e.g. user errors). | | `do we want this?` | [search][search-label-do-we-want-this] | Seeking stakeholder consensus on proposed feature. | -[search-label-enhancement]: https://github.com/search?q=is%3Aopen+is%3Aissue+repo%3APegasysEng%2Fdiscv5+label%3Aenhancement -[search-label-bug]: https://github.com/search?q=is%3Aopen+is%3Aissue+repo%3APegasysEng%2Fdiscv5+label%3Abug -[search-label-help-wanted]: https://github.com/search?q=is%3Aopen+is%3Aissue+repo%3APegasysEng%2Fdiscv5+label%3Ahelp%20wanted -[search-label-good-first-issue]: https://github.com/search?q=is%3Aopen+is%3Aissue+repo%3APegasysEng%2Fdiscv5+label%3Agood%20first%20issue -[search-label-info-needed]: https://github.com/search?q=is%3Aopen+is%3Aissue+repo%3APegasysEng%2Fdiscv5+label%3Ainfo%20needed -[search-label-needs-reproduction]: https://github.com/search?q=is%3Aopen+is%3Aissue+repo%3APegasysEng%2Fdiscv5+label%3Aneeds%20reproduction -[search-label-blocked]: https://github.com/search?q=is%3Aopen+is%3Aissue+repo%3APegasysEng%2Fdiscv5+label%3Ablocked -[search-label-duplicate]: https://github.com/search?q=is%3Aopen+is%3Aissue+repo%3APegasysEng%2Fdiscv5+label%3Aduplicate -[search-label-wontfix]: https://github.com/search?q=is%3Aopen+is%3Aissue+repo%3APegasysEng%2Fdiscv5+label%3Awontfix -[search-label-invalid]: https://github.com/search?q=is%3Aopen+is%3Aissue+repo%3APegasysEng%2Fdiscv5+label%3Ainvalid -[search-label-work-in-progress]: https://github.com/search?q=is%3Aopen+is%3Apr+repo%3APegasysEng%2Fdiscv5+label%3Awork%20in%20progress -[search-label-requires-changes]: https://github.com/search?q=is%3Aopen+is%3Apr+repo%3APegasysEng%2Fdiscv5+label%3Arequires%20changes -[search-label-do-we-want-this]: https://github.com/search?q=is%3Aopen+is%3Apr+repo%3APegasysEng%2Fdiscv5+label%3Ado%20we%20want%20this +[search-label-enhancement]: https://github.com/search?q=is%3Aopen+is%3Aissue+repo%3APegasysEng%2Fdiscovery+label%3Aenhancement +[search-label-bug]: https://github.com/search?q=is%3Aopen+is%3Aissue+repo%3APegasysEng%2Fdiscovery+label%3Abug +[search-label-help-wanted]: https://github.com/search?q=is%3Aopen+is%3Aissue+repo%3APegasysEng%2Fdiscovery+label%3Ahelp%20wanted +[search-label-good-first-issue]: https://github.com/search?q=is%3Aopen+is%3Aissue+repo%3APegasysEng%2Fdiscovery+label%3Agood%20first%20issue +[search-label-info-needed]: https://github.com/search?q=is%3Aopen+is%3Aissue+repo%3APegasysEng%2Fdiscovery+label%3Ainfo%20needed +[search-label-needs-reproduction]: https://github.com/search?q=is%3Aopen+is%3Aissue+repo%3APegasysEng%2Fdiscovery+label%3Aneeds%20reproduction +[search-label-blocked]: https://github.com/search?q=is%3Aopen+is%3Aissue+repo%3APegasysEng%2Fdiscovery+label%3Ablocked +[search-label-duplicate]: https://github.com/search?q=is%3Aopen+is%3Aissue+repo%3APegasysEng%2Fdiscovery+label%3Aduplicate +[search-label-wontfix]: https://github.com/search?q=is%3Aopen+is%3Aissue+repo%3APegasysEng%2Fdiscovery+label%3Awontfix +[search-label-invalid]: https://github.com/search?q=is%3Aopen+is%3Aissue+repo%3APegasysEng%2Fdiscovery+label%3Ainvalid +[search-label-work-in-progress]: https://github.com/search?q=is%3Aopen+is%3Apr+repo%3APegasysEng%2Fdiscovery+label%3Awork%20in%20progress +[search-label-requires-changes]: https://github.com/search?q=is%3Aopen+is%3Apr+repo%3APegasysEng%2Fdiscovery+label%3Arequires%20changes +[search-label-do-we-want-this]: https://github.com/search?q=is%3Aopen+is%3Apr+repo%3APegasysEng%2Fdiscovery+label%3Ado%20we%20want%20this [private@pegasys.tech]: mailto:private@pegasys.tech -[Gitter]: https://gitter.im/PegaSysEng/discv5 -[Wiki]: https://github.com/PegaSysEng/discv5/wiki -[Debugging Wiki]: https://github.com/PegaSysEng/discv5/wiki/Debugging +[Gitter]: https://gitter.im/PegaSysEng/discovery +[Wiki]: https://github.com/PegaSysEng/discovery/wiki +[Debugging Wiki]: https://github.com/PegaSysEng/discovery/wiki/Debugging [CLA.md]: /CLA.md [Code Reviews]: /docs/community/code-reviews.md diff --git a/build.gradle b/build.gradle index 04a82c904..0e0659039 100644 --- a/build.gradle +++ b/build.gradle @@ -1,5 +1,7 @@ import net.ltgt.gradle.errorprone.CheckSeverity +//discovery v5 + plugins { id 'java-library' id 'com.diffplug.gradle.spotless' version '3.26.0' @@ -148,7 +150,7 @@ apply plugin: 'maven-publish' publishing { publications { mavenJava(MavenPublication) { - groupId "tech.pegasys.discv5" + groupId "tech.pegasys.discovery" version "${project.version}" from components.java artifact sourcesJar @@ -159,7 +161,7 @@ publishing { } pom { name = "${project.name}" - url = 'http://github.com/PegaSysEng/discv5' + url = 'http://github.com/PegaSysEng/discovery' licenses { license { name = 'The Apache License, Version 2.0' @@ -167,9 +169,9 @@ publishing { } } scm { - connection = 'scm:git:git://github.com/PegaSysEng/discv5.git' - developerConnection = 'scm:git:ssh://github.com/PegaSysEng/discv5.git' - url = 'https://github.com/PegaSysEng/discv5' + connection = 'scm:git:git://github.com/PegaSysEng/discovery.git' + developerConnection = 'scm:git:ssh://github.com/PegaSysEng/discovery.git' + url = 'https://github.com/PegaSysEng/discovery' } } } @@ -187,13 +189,13 @@ bintray { pkg { repo = 'pegasys-repo' - name = 'discv5' + name = 'discovery' userOrg = 'consensys' desc = 'Java implementation of discovery v5' licenses = ['Apache-2.0'] - websiteUrl = 'https://github.com/PegaSysEng/discv5' - issueTrackerUrl = 'https://github.com/PegaSysEng/discv5/issues' - vcsUrl = 'https://github.com/PegaSysEng/discv5.git' + websiteUrl = 'https://github.com/PegaSysEng/discovery' + issueTrackerUrl = 'https://github.com/PegaSysEng/discovery/issues' + vcsUrl = 'https://github.com/PegaSysEng/discovery.git' version { name = project.version diff --git a/gradle/check-licenses.gradle b/gradle/check-licenses.gradle index 53365b6ab..a4cd69df0 100644 --- a/gradle/check-licenses.gradle +++ b/gradle/check-licenses.gradle @@ -14,6 +14,10 @@ /** * The lists of the license we accept. */ +license { + excludePatterns = ['**/*.md', '**/*.sh'] as Set +} + ext.acceptedLicenses = [ 'BSD License', 'BSD 2-Clause', @@ -132,7 +136,7 @@ downloadLicenses { ] licenses = [ - (group('discv5')) : apache, + (group('discovery')) : apache, // https://checkerframework.org/manual/#license // The more permissive MIT License applies to code that you might want diff --git a/settings.gradle b/settings.gradle index f9069d9dc..9ecca70d8 100644 --- a/settings.gradle +++ b/settings.gradle @@ -7,4 +7,4 @@ * in the user manual at https://docs.gradle.org/6.0.1/userguide/multi_project_builds.html */ -rootProject.name = 'discv5' +rootProject.name = 'discovery'