You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucenenet.apache.org by ni...@apache.org on 2020/04/14 14:48:19 UTC
[lucenenet] branch master updated: CONTRIBUTING.md + README.md +
websites: Changed JIRA references to GitHub Issues.
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 e95dfa3 CONTRIBUTING.md + README.md + websites: Changed JIRA references to GitHub Issues.
e95dfa3 is described below
commit e95dfa39700ee0a8168a01c07c2f8849b0380cba
Author: Shad Storhaug <sh...@shadstorhaug.com>
AuthorDate: Tue Apr 14 21:42:11 2020 +0700
CONTRIBUTING.md + README.md + websites: Changed JIRA references to GitHub Issues.
---
CONTRIBUTING.md | 13 +++----
README.md | 46 ++++++++++++------------
websites/site/contributing/index.md | 4 +--
websites/site/contributing/issue-tracker.md | 2 +-
websites/site/contributing/mailing-lists.md | 2 +-
websites/site/lucenetemplate/doap_Lucene_Net.rdf | 2 +-
6 files changed, 34 insertions(+), 35 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 01a970a..fc1718e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -5,28 +5,29 @@ You have found a bug or you have an idea for a cool new enhancement? Contributin
## Getting Started
- Read [Open Source Contribution Etiquette](http://tirania.org/blog/archive/2010/Dec-31.html) and [Don't "Push" Your Pull Requests](http://www.igvita.com/2011/12/19/dont-push-your-pull-requests/).
-- Make sure you have a [JIRA account](https://cwiki.apache.org/confluence/signup.action).
- Make sure you have a [GitHub account](https://github.com/signup/free). NOTE: Although this is a mirror of our Git repository, pull requests are accepted through GitHub.
- If you are thinking of adding a feature, we would appreciate you opening a discussion on our [developer mailing list](https://cwiki.apache.org/confluence/display/LUCENENET/Mailing+Lists) before you start writing. It could save both you and our team quite a bit of work if the code doesn't have to be rewritten to fit in with our overall objectives.
-- Submit a JIRA ticket for your issue, assuming one doesn't exist already.
+- Submit a [new issue on GitHub](https://github.com/apache/lucenenet/issues), assuming one doesn't exist already.
- If reporting a bug, clearly describe the issue including steps to reproduce, observed behavior, and expected behavior.
- If reporting a bug, provide source code that we can run without any alteration demonstrating the issue. Issues submitted with runnable code will be given a higher priority than those submitted without.
-- If you will be submitting a pull request, fork the repository on GitHub.
+- If you will be submitting a [pull request](https://github.com/apache/lucenenet/pulls), fork the repository on GitHub.
- Create a new branch with a descriptive name (tracking master) and [submit a Pull Request](https://help.github.com/articles/creating-a-pull-request/).
+
+> **NOTE:** In the past, the Lucene.NET project used the [JIRA issue tracker](https://issues.apache.org/jira/projects/LUCENENET/issues), which has now been deprecated. However, we are keeping it active for tracking legacy issues. Please submit any new issues to GitHub.
## Up For Grabs
-There are several [**Open Issues on JIRA**](https://issues.apache.org/jira/projects/LUCENENET/issues) that are marked `up-for-grabs` that we could use help with.
+There are several [**Open Issues on GitHub**](https://github.com/apache/lucenenet/labels/up-for-grabs) that are marked `up-for-grabs` that we could use help with.
## Other Ways To Help
-* Be a power beta tester. Make it your mission to track down bugs and report them to us on [JIRA](https://issues.apache.org/jira/issues/?jql=project%20%3D%20LUCENENET%20AND%20status%20%3D%20Open).
+* 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 [...]
* 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.
-* Reviewing code. Pick a random section, review line by line, comparing the code against the [original Lucene 4.8.0 code](https://github.com/apache/lucene-solr/tree/releases/lucene-solr/4.8.0/lucene). Many of the bugs have been found this way, as the tests are not showing them. Let us know if you find anything suspicious on the [dev mailing list](https://cwiki.apache.org/confluence/display/LUCENENET/Mailing+Lists) or submit a pull request.
+* Reviewing code. Pick a random section, review line by line, comparing the code against the [original Lucene 4.8.0 code](https://github.com/apache/lucene-solr/tree/releases/lucene-solr/4.8.0/lucene). Many of the bugs have been found this way, as the tests are not showing them. Let us know if you find anything suspicious on the [dev mailing list](https://cwiki.apache.org/confluence/display/LUCENENET/Mailing+Lists) or [submit a pull request](https://help.github.com/en/github/collaborating [...]
* Creating projects to make Lucene.Net easier to use with various .NET frameworks (ASP.NET MVC, WebApi, AspNetCore, WPF, EntityFramework, etc). In general, we would like common tasks as easy as possible to integrate into applications build on these frameworks without everyone having to write the same boilerplate code.
* Building automation tools to eliminate some of the manual work of managing the project, updating information on various web pages, creating tools to make porting/upgrading more automated, etc.
diff --git a/README.md b/README.md
index ea2436f..152afcd 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,24 @@
-# Apache Lucene.Net
+# Apache Lucene.NET
[](https://www.nuget.org/packages/Lucene.Net)
[](https://dev.azure.com/lucene-net/Lucene.NET/_build?definitionId=3&_a=summary)
-[](https://github.com/NightOwl888/ICU4N/blob/master/LICENSE.txt)
+[](https://github.com/apache/lucenenet/blob/master/LICENSE.txt)
## Full-text search for .NET
-Apache Lucene.Net is a .NET full-text search engine framework, a C# port of the popular Apache Lucene project. Apache Lucene.Net is not a complete application, but rather a code library and API that can easily be used to add search capabilities to applications.
+Apache Lucene.NET is a .NET full-text search engine framework, a C# port of the popular Apache Lucene project. Apache Lucene.NET is not a complete application, but rather a code library and API that can easily be used to add search capabilities to applications.
-The Apache Lucene.Net web site is at:
+The Apache Lucene.NET web site is at:
http://lucenenet.apache.org
## Supported Frameworks
-### Lucene.Net 3.0.3
+### Lucene.NET 3.0.3
- .NET Framework 4.0
- .NET Framework 3.5
-### Lucene.Net 4.8.0
+### Lucene.NET 4.8.0
- [.NET Standard 2.1](https://docs.microsoft.com/en-us/dotnet/standard/net-standard)
@@ -27,13 +27,13 @@ The Apache Lucene.Net web site is at:
## Status
-Latest Stable Version: Lucene.Net 3.0.3
+Latest Stable Version: Lucene.NET 3.0.3
-Working toward Lucene.Net 4.8.0 (currently in BETA)
+Working toward Lucene.NET 4.8.0 (currently in BETA)
## Download
-### Lucene.Net 3.0.3
+### Lucene.NET 3.0.3
##### Core Library
@@ -50,7 +50,7 @@ PM> Install-Package Lucene.Net
- [Lucene.Net.Contrib.Spatial](https://www.nuget.org/packages/Lucene.Net.Contrib.Spatial/3.0.3) - Geospatial Search
- [Lucene.Net.Contrib.Spatial.NTS](https://www.nuget.org/packages/Lucene.Net.Contrib.Spatial.NTS/3.0.3) - Geospatial search with support for NetTopologySuite.
-### Lucene.Net 4.8.0
+### Lucene.NET 4.8.0
##### Core Library
@@ -97,7 +97,7 @@ PM> Install-Package Lucene.Net -Pre
## Documentation
-We now have some preliminary documentation for Lucene.Net 4.8.0 [on the Lucene.Net Website](https://lucenenet.apache.org/).
+We now have some preliminary documentation for Lucene.NET 4.8.0 [on the Lucene.NET Website](https://lucenenet.apache.org/).
The API is similar to Java [Lucene 4.8.0](https://lucene.apache.org/core/4_8_0/), which you may also find helpful to review.
@@ -112,7 +112,7 @@ The API is similar to Java [Lucene 4.8.0](https://lucene.apache.org/core/4_8_0/)
There are several demos implemented as simple console applications that can be copied and pasted into Visual Studio or compiled on the command line in the [Lucene.Net.Demo project](https://github.com/apache/lucenenet/tree/master/src/Lucene.Net.Demo).
-There is also a dotnet command line tool available on NuGet. It contains all of the demos as well as tools maintaining your Lucene.Net index, featuring operations such as splitting, merging, listing segment info, fixing, deleting segments, upgrading, etc. Always be sure to back up your index before running any commands against it!
+There is also a dotnet command line tool available on NuGet. It contains all of the demos as well as tools maintaining your Lucene.NET index, featuring operations such as splitting, merging, listing segment info, fixing, deleting segments, upgrading, etc. Always be sure to back up your index before running any commands against it!
- [Prerequisite: .NET Core 3.1.0 Runtime](https://www.microsoft.com/net/download/core#/runtime)
@@ -126,7 +126,7 @@ Once installed, you can explore the commands and options that are available by e
## How to Contribute
-Lucene.Net is a very large project (over 400,000 executable lines of code and nearly 1,000,000 lines of text total) and we welcome any and all help to maintain such an effort. Read our [Contribution Guide](https://github.com/apache/lucenenet/blob/master/CONTRIBUTING.md) or read on for ways that you can help.
+We love getting contributions! Read our [Contribution Guide](https://github.com/apache/lucenenet/blob/master/CONTRIBUTING.md) or read on for ways that you can help.
### Join Mailing Lists
@@ -134,27 +134,25 @@ Lucene.Net is a very large project (over 400,000 executable lines of code and ne
### Ask a Question
-If you have a general how-to question or need help from the Lucene.Net community, please email the Apache Lucene.Net-User mailing list by sending a message to:
+If you have a general how-to question or need help from the Lucene.NET community, please subscribe to the `user` mailing list by sending an email to [user-subscribe@lucenenet.apache.org](mailto:user-subscribe@lucenenet.apache.org) and then follow the instructions to verify your email address. Note that you only need to subscribe once.
-[user@lucenenet.apache.org](mailto:user@lucenenet.apache.org)
+After you have subscribed to the mailing list, email your message to [user@lucenenet.apache.org](mailto:user@lucenenet.apache.org).
-Note that you need to join the [user mailing list](https://cwiki.apache.org/confluence/display/LUCENENET/Mailing+Lists) to see replies.
+Alternatively, you can get help via [StackOverflow](https://stackoverflow.com/questions/tagged/lucene.net)'s active community.
-Alternatively, you can get help via [StackOverflow](https://stackoverflow.com/questions/tagged/lucene.net).
-
-Please do not submit general how-to questions to JIRA, use JIRA for bug reports/tasks only.
+Please do not submit general how-to questions to GitHub, use GitHub for bug reports and tasks only.
### Report a Bug
-To report a bug, please use the [JIRA issue tracker](https://issues.apache.org/jira/issues/?jql=project%20%3D%20LUCENENET%20AND%20status%20%3D%20Open). You can signup for a JIRA account [here](https://cwiki.apache.org/confluence/signup.action) (it just takes a minute).
+To report a bug, please use the [GitHub issue tracker](https://github.com/apache/lucenenet/issues).
-### Start a Discussion
+> **NOTE:** In the past, the Lucene.NET project used the [JIRA issue tracker](https://issues.apache.org/jira/projects/LUCENENET/issues), which has now been deprecated. However, we are keeping it active for tracking legacy issues. Please submit any new issues to GitHub.
-To start a development discussion regarding technical features of Lucene.Net, please email the Apache Lucene.Net-Developer mailing list by sending a message to:
+### Start a Discussion
-[dev@lucenenet.apache.org](mailto:dev@lucenenet.apache.org)
+To start a development discussion regarding technical features of Lucene.NET, please email the `dev` mailing list by sending an email to [dev-subscribe@lucenenet.apache.org](mailto:dev-subscribe@lucenenet.apache.org) and then follow the instructions to verify your email address. Note that you only need to subscribe once.
-Note that you need to join the [dev mailing lists](https://cwiki.apache.org/confluence/display/LUCENENET/Mailing+Lists) to see replies.
+After you have subscribed to the mailing list, email your message to [dev@lucenenet.apache.org](mailto:dev@lucenenet.apache.org).
### Submit a Pull Request
diff --git a/websites/site/contributing/index.md b/websites/site/contributing/index.md
index 48a1f66..3c052fe 100644
--- a/websites/site/contributing/index.md
+++ b/websites/site/contributing/index.md
@@ -22,7 +22,7 @@ We recommend you join the [user mailing list](https://cwiki.apache.org/confluenc
Alternatively, you can get help via [StackOverflow](https://stackoverflow.com/questions/tagged/lucene.net).
-Please do not submit general how-to questions to JIRA, use JIRA for bug reports/tasks only.
+Please do not submit general how-to questions to GitHub, use GitHub Issues for bug reports and tasks only.
see __[mailing lists](xref:contributing/mailing-lists)__
@@ -42,7 +42,7 @@ Help with keeping this website and documentation up to date would be a great hel
### Report a Bug
-To report a bug, please use the [JIRA issue tracker](xref:contributing/issue-tracker). You can signup for a JIRA account [here](https://cwiki.apache.org/confluence/signup.action) (it just takes a minute).
+To report a bug, please use the [GitHub issue tracker](xref:contributing/issue-tracker).
### Submit a Pull Request
diff --git a/websites/site/contributing/issue-tracker.md b/websites/site/contributing/issue-tracker.md
index d5eeaab..e1c09f2 100644
--- a/websites/site/contributing/issue-tracker.md
+++ b/websites/site/contributing/issue-tracker.md
@@ -6,4 +6,4 @@ Issue Tracker
---------------
-Follow what we are working on, help us by submitting patches, or submit your own enhancement or bug requests at our issue tracker: __[Lucene.Net JIRA](https://issues.apache.org/jira/browse/LUCENENET)__
\ No newline at end of file
+Follow what we are working on, help us by submitting patches, or submit your own enhancement or bug requests at our issue tracker: __[Lucene.NET GitHub](https://github.com/apache/lucenenet/issues)__
\ No newline at end of file
diff --git a/websites/site/contributing/mailing-lists.md b/websites/site/contributing/mailing-lists.md
index 01b3944..d5c2efc 100644
--- a/websites/site/contributing/mailing-lists.md
+++ b/websites/site/contributing/mailing-lists.md
@@ -9,7 +9,7 @@ Mailing Lists
### Developers <small>(dev@lucenenet.apache.org)</small>
-The developers mailing list is used to discuss the technical future of Lucene.Net. This mailing list also recieves JIRA items and comments and notifications from github
+The developers mailing list is used to discuss the technical future of Lucene.Net. This mailing list also recieves comments and notifications from GitHub
_To subscribe to this mailing lists, send an email to [dev-subscribe@lucenenet.apache.org](mailto:dev-subscribe@lucenenet.apache.org). To unsubscribe, send an email to [dev-unsubscribe@lucenenet.apache.org](mailto:dev-unsubscribe@lucenenet.apache.org)._
diff --git a/websites/site/lucenetemplate/doap_Lucene_Net.rdf b/websites/site/lucenetemplate/doap_Lucene_Net.rdf
index be4445a..aa2e1b9 100644
--- a/websites/site/lucenetemplate/doap_Lucene_Net.rdf
+++ b/websites/site/lucenetemplate/doap_Lucene_Net.rdf
@@ -34,7 +34,7 @@
2. Maintaining the high-performance requirements expected of a first class C# search engine library;
3. Maximize usability and power when used within the .NET runtime. To that end, it will present a highly idiomatic, carefully tailored API that takes advantage of many of the special features of the .NET runtime.
</description>
- <bug-database rdf:resource="https://issues.apache.org/jira/browse/LUCENENET/" />
+ <bug-database rdf:resource="https://github.com/apache/lucenenet/issues" />
<mailing-list rdf:resource="http://lucenenet.apache.org/community.html" />
<download-page rdf:resource="http://lucenenet.apache.org/download.cgi" />
<programming-language>C#</programming-language>