This is an automated email from the ASF dual-hosted git repository.
nightowl888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git
The following commit(s) were added to refs/heads/master by this push:
new b708036cf Spellchecking on markdown and text files (#646)
b708036cf is described below
commit b708036cf52a4e459d6c9e6cab51c64edba7f9e3
Author: Nikolaj Brask-Nielsen <[email protected]>
AuthorDate: Sat Oct 15 15:07:13 2022 +0200
Spellchecking on markdown and text files (#646)
* docs: Spellchecking
* docs: Spellchecking review changes
* docs: fix missing line
* docs: Added reivew changes
---
ACKNOWLEDGEMENTS.txt | 4 ++--
CONTRIBUTING.md | 4 ++--
README.md | 12 ++++++------
3 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/ACKNOWLEDGEMENTS.txt b/ACKNOWLEDGEMENTS.txt
index 1ba84cc82..91fd0e2fb 100644
--- a/ACKNOWLEDGEMENTS.txt
+++ b/ACKNOWLEDGEMENTS.txt
@@ -7,6 +7,6 @@ were developed by Martin Porter and Richard Boulton.
The full snowball package is available from http://snowball.tartarus.org/
Apache Lucene.Net is a port of Jakarta Lucene to C#.
-The port from Java to C# of version 1.4.0, 1.4.3, 1.9, 1.9.1, 2.0 and 2.1 were
done
-primary by George Aroush. To contact George Aroush please visit
http://www.aroush.net/.
+The port from Java to C# of versions 1.4.0, 1.4.3, 1.9, 1.9.1, 2.0 and 2.1
were done
+primarily by George Aroush. To contact George Aroush please visit
http://www.aroush.net/.
Much thanks to George
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index fc1718e62..9304186d5 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
# Lucene.NET Contributor's Guide
-You have found a bug or you have an idea for a cool new enhancement?
Contributing code is a great way to give something back to the open source
community. Before you dig right into the code there are a few guidelines that
we need contributors to follow so that we can have a chance of keeping on top
of things.
+Have you found a bug or do you have an idea for a cool new enhancement?
Contributing code is a great way to give something back to the open-source
community. Before you dig right into the code there are a few guidelines that
we need contributors to follow so that we can have a chance of keeping on top
of things.
## Getting Started
@@ -23,7 +23,7 @@ There are several [**Open Issues on
GitHub**](https://github.com/apache/lucenene
* Be a power beta tester. Make it your mission to track down bugs and report
them to us on [GitHub](https://github.com/apache/lucenenet/issues).
* Optimizing code. During porting we have ended up with some code that is less
than optimal. We could use a hand getting everything up to speed (pun intended).
-* Helping update the API, or at least just providing feedback on which API
changes are affecting usability. There are several things on our radar, like
integrating something like
[Lucene.Net.Linq](https://github.com/themotleyfool/Lucene.Net.Linq) directly
into our project, [converting the remaining public-facing iterator classes into
`IEnumerator<T>`](https://issues.apache.org/jira/projects/LUCENENET/issues/LUCENENET-469?filter=allopenissues)
so they can be used with foreach loops, addin [...]
+* Helping update the API, or at least just providing feedback on which API
changes are affecting the usability. There are several things on our radar,
like integrating something like
[Lucene.Net.Linq](https://github.com/themotleyfool/Lucene.Net.Linq) directly
into our project, [converting the remaining public-facing iterator classes into
`IEnumerator<T>`](https://issues.apache.org/jira/projects/LUCENENET/issues/LUCENENET-469?filter=allopenissues)
so they can be used with foreach loops, a [...]
* Making demos and tutorials, blogging about Lucene.Net, etc. (and providing
feedback on how we can make the API better!). If you write a helpful Lucene.Net
post on your blog, be sure to let us know so we can link to it.
* Helping out with documentation. We are still trying to make the API docs
easily navigable (see #206), and there are many files that are not formatted
correctly (links not appearing, tables not very readable, etc). Also, we need
help getting all of the Java-related documentation converted to use .NET
methodologies.
* Fixing TODOs. There are several TODOs throughout the code that need to be
reviewed and action taken, if necessary. Search for `LUCENENET TODO|LUCENE
TO-DO` using the regular expression option in Visual Studio to find them. Do
note there are a lot of TODOs left over from Java Lucene that are safe to
ignore.
diff --git a/README.md b/README.md
index b46763a25..cc9bc5db2 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@ Apache Lucene.NET is a .NET library providing powerful
indexing and search featu
Lucene.NET version 4.8 (still in Beta) runs everywhere .NET runs, including
Windows, Unix, MacOS, Android and iOS.
-The Apache Lucene.NET web site is at:
+The Apache Lucene.NET website is at:
http://lucenenet.apache.org
## Supported Frameworks
@@ -163,7 +163,7 @@ To report a bug, please use the [GitHub issue
tracker](https://github.com/apache
### Start a Discussion
-To start a development discussion regarding technical features of Lucene.NET,
please email the `dev` mailing list by sending an email to
[[email protected]](mailto:[email protected])
and then follow the instructions to verify your email address. Note that you
only need to subscribe once.
+To start a development discussion regarding the technical features of
Lucene.NET, please email the `dev` mailing list by sending an email to
[[email protected]](mailto:[email protected])
and then follow the instructions to verify your email address. Note that you
only need to subscribe once.
After you have subscribed to the mailing list, email your message to
[[email protected]](mailto:[email protected]).
@@ -202,7 +202,7 @@ To build the source, clone or download and unzip the
repository. For specific re
##### Build Options
-The following options are case-insensitive. Each option has both a short form
indicated by a single `-` and a long form indicated by `--`. The options that
require a value must be followed by a space and then the value, similar to
running the [dotnet CLI](https://docs.microsoft.com/en-us/dotnet/core/tools/).
+The following options are case-insensitive. Each option has both a short form
indicated by a single `-` and a long-form indicated by `--`. The options that
require a value must be followed by a space and then the value, similar to
running the [dotnet CLI](https://docs.microsoft.com/en-us/dotnet/core/tools/).
<table>
<tr>
@@ -238,12 +238,12 @@ The following options are case-insensitive. Each option
has both a short form in
<tr>
<td>‑fv</td>
<td>‑‑file-version</td>
- <td>The assembly file version. If not supplied, will use the
--package-version (excluding any pre-release tag). The assembly version is
generated as the major version of this value without the minor, build, or
revision compoenents.</td>
+ <td>The assembly file version. If not supplied, defaults to the
--package-version value (excluding any pre-release label). The assembly version
will be derived from the major version component of the passed in value,
excluding the minor, build and revision components.</td>
<td>build ‑pv 4.8.0‑beta00001 ‑fv
4.8.0</td>
</tr>
</table>
-For example the following command creates a Release build with NuGet package
version 4.8.0‑ci00015 and file version 4.8.0. Assembly version will be equal to
the passed in major version (in this case 4.0.0).
+For example, the following command creates a Release build with NuGet package
version 4.8.0‑ci00015 and file version 4.8.0. The assembly version will be
derived from the major version component of the passed in value, excluding the
minor, build and revision components (in this case 4.0.0).
###### Windows
@@ -257,7 +257,7 @@ For example the following command creates a Release build
with NuGet package ver
./build ‑‑configuration Release ‑pv 4.8.0‑ci00015 ‑fv 4.8.0
```
-In the above example we are using "ci" in the package version to indicate this
is not a publicly released beta version but rather the output of a continuous
integration build from master which occurred after beta00014 but before
beta00015 was released.
+In the above example, we are using "ci" in the package version to indicate
this is not a publicly released beta version but rather the output of a
continuous integration build from master which occurred after beta00014 but
before beta00015 was released.
NuGet packages are output by the build to the `/_artifacts/NuGetPackages/`
directory. Test results (if applicable) are output to the
`/_artifacts/TestResults/` directory.
