You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@groovy.apache.org by pa...@apache.org on 2022/10/19 01:54:37 UTC

[groovy] branch master updated: Polish project documentation

This is an automated email from the ASF dual-hosted git repository.

paulk pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/groovy.git


The following commit(s) were added to refs/heads/master by this push:
     new c131eefe4b Polish project documentation
c131eefe4b is described below

commit c131eefe4b8ea0b9175a2eff3205396c516dd442
Author: Marc Wrobel <ma...@gmail.com>
AuthorDate: Tue Oct 18 12:31:54 2022 +0200

    Polish project documentation
    
    Use proper spelling for GitHub and fix a few typos.
---
 CONTRIBUTING.md                |  4 ++--
 README.adoc                    | 10 +++++-----
 subprojects/stress/README.adoc |  2 +-
 3 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b7523baa58..0c21375e8f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -17,6 +17,6 @@ limitations under the License.
 # Contributing
 
 Please visit the
-[project development web site](https://groovy.apache.org/)
+[project development website](https://groovy.apache.org/)
 to find out more about contributing to the project.
-We welcome all contributors.
\ No newline at end of file
+We welcome all contributors.
diff --git a/README.adoc b/README.adoc
index ff41041083..76a99f0300 100644
--- a/README.adoc
+++ b/README.adoc
@@ -80,14 +80,14 @@ Apache Groovy uses Git. The official Git repository is at:
 
     https://gitbox.apache.org/repos/asf/groovy.git
 
-And a mirror is hosted on Github:
+And a mirror is hosted on GitHub:
 
     https://github.com/apache/groovy
 
-The Github mirror is read-only and provides convenience to users and developers to explore the code and for the
-community to accept contributions via Github Pull Requests.
+The GitHub mirror is read-only and provides convenience to users and developers to explore the code and for the
+community to accept contributions via GitHub Pull Requests.
 
-Simply `git clone` the repo (or the repo you forked via the github website) and you will have the complete source.
+Simply `git clone` the repo (or the repo you forked via the GitHub website) and you will have the complete source.
 
 === Unpacking the src distribution
 
@@ -100,7 +100,7 @@ use it to execute one bootstrap step.
 ==== Bootstrapping Gradle
 
 As mentioned in the previous paragraph, if you download the source distribution
-you need to bootstrap Gradle. This isn't needed if you clone from the Github repo.
+you need to bootstrap Gradle. This isn't needed if you clone from the GitHub repo.
 
 Each version of Groovy is built and tested using a specific version of Gradle.
 That version is specified by the `gradle_version` property defined in the `gradle.properties`
diff --git a/subprojects/stress/README.adoc b/subprojects/stress/README.adoc
index 745b837716..7b70c951d0 100644
--- a/subprojects/stress/README.adoc
+++ b/subprojects/stress/README.adoc
@@ -25,7 +25,7 @@ Tests in this subproject are used for stress testing.  These types of tests
 will normally involve calls to `System.gc()`, spinning up many threads, and
 may attempt to create OutOfMemory errors.
 
-These tests can be long running and may be prone to failure on different
+These tests can be long-running and may be prone to failure on different
 platforms, so in order to run these tests you must enable them as follows:
 
     ./gradlew -PstressTests :stress:test