janhoy commented on code in PR #1177: URL: https://github.com/apache/solr/pull/1177#discussion_r1044441376
########## CONTRIBUTING.md: ########## @@ -0,0 +1,34 @@ +# Contribute To Solr + +Thank you for your interest in contributing to the Apache Solr project. Solr continues to improve via the many contributions of developers around the world and new contributions are welcomed and encouraged. + +Your suggestions, comments and comments on Doris can be made directly through the [Apache Solr JIRA](https://issues.apache.org/jira/projects/SOLR/issues). Review Comment: ```suggestion Your suggestions and comments can be made directly through the [Apache Solr JIRA](https://issues.apache.org/jira/projects/SOLR/issues). ``` ########## CONTRIBUTING.md: ########## @@ -0,0 +1,34 @@ +# Contribute To Solr + +Thank you for your interest in contributing to the Apache Solr project. Solr continues to improve via the many contributions of developers around the world and new contributions are welcomed and encouraged. + +Your suggestions, comments and comments on Doris can be made directly through the [Apache Solr JIRA](https://issues.apache.org/jira/projects/SOLR/issues). + +There are many ways to participate in and contribute to Solr, such as: code implementation, test implementation, documentation improvements. + +If you have any questions along the way, you can reach out to the community using the resources provided [here](https://solr.apache.org/community.html#mailing-lists-chat). + +## How To Contribute + +Information on how to contribute can be found [here](https://github.com/apache/solr/blob/main/dev-docs/how-to-contribute.adoc). Review Comment: Instead of 'here' links, try to spell it out. Also, can the adoc link be relative and still work on github.com? ```suggestion Information on how to contribute can be found in [dev-docs/how-to-contribute.adoc](https://github.com/apache/solr/blob/main/dev-docs/how-to-contribute.adoc). ``` ########## CONTRIBUTING.md: ########## @@ -0,0 +1,34 @@ +# Contribute To Solr + +Thank you for your interest in contributing to the Apache Solr project. Solr continues to improve via the many contributions of developers around the world and new contributions are welcomed and encouraged. + +Your suggestions, comments and comments on Doris can be made directly through the [Apache Solr JIRA](https://issues.apache.org/jira/projects/SOLR/issues). + +There are many ways to participate in and contribute to Solr, such as: code implementation, test implementation, documentation improvements. + +If you have any questions along the way, you can reach out to the community using the resources provided [here](https://solr.apache.org/community.html#mailing-lists-chat). + +## How To Contribute + +Information on how to contribute can be found [here](https://github.com/apache/solr/blob/main/dev-docs/how-to-contribute.adoc). + +## Contributing Documentation + +One very helpful area for contribution to Solr is via documentation improvements and additions to help make Solr easier to use for others. You can read more about how to modify and update Solr documentation [here](https://github.com/apache/solr/blob/main/solr/solr-ref-guide/README.adoc). Review Comment: ```suggestion One very helpful area for contribution to Solr is via documentation improvements and additions to help make Solr easier to use for others. You can read more about how to modify and update Solr documentation in the [Solr Reference Guide README](https://github.com/apache/solr/blob/main/solr/solr-ref-guide/README.adoc). ``` ########## CONTRIBUTING.md: ########## @@ -0,0 +1,34 @@ +# Contribute To Solr + +Thank you for your interest in contributing to the Apache Solr project. Solr continues to improve via the many contributions of developers around the world and new contributions are welcomed and encouraged. + +Your suggestions, comments and comments on Doris can be made directly through the [Apache Solr JIRA](https://issues.apache.org/jira/projects/SOLR/issues). + +There are many ways to participate in and contribute to Solr, such as: code implementation, test implementation, documentation improvements. + +If you have any questions along the way, you can reach out to the community using the resources provided [here](https://solr.apache.org/community.html#mailing-lists-chat). + +## How To Contribute + +Information on how to contribute can be found [here](https://github.com/apache/solr/blob/main/dev-docs/how-to-contribute.adoc). + +## Contributing Documentation + +One very helpful area for contribution to Solr is via documentation improvements and additions to help make Solr easier to use for others. You can read more about how to modify and update Solr documentation [here](https://github.com/apache/solr/blob/main/solr/solr-ref-guide/README.adoc). + Review Comment: Add also links to dev-docs and `solr-site` repo README to let people know they can contribute to that part of the docs as well. ########## dev-docs/how-to-contribute.adoc: ########## @@ -0,0 +1,23 @@ +# How To Contribute + +The Apache Solr Github Repository is located here: https://github.com/apache/solr. Typically all contributions to Solr are developed on a fork of the Solr repository, then opened as PRs against the `main` branch in the solr repository. These PRs are then linked to an open JIRA issue and members of the community will review, comment, approve, and commit changes. + +Please keep in mind that the Solr is community driven with many members taking their own personal time to help respond to issue and review PRs. Be open to feedback and discussions and maintain a respectful approach. Review Comment: ```suggestion Please keep in mind that the project is community driven, with many members taking their own personal time to help respond to issue and review PRs. Be open to feedback and discussions and maintain a respectful approach. Read our https://solr.apache.org/community.html#code-of-conduct[code of conduct] for more. ``` ########## CONTRIBUTING.md: ########## @@ -0,0 +1,34 @@ +# Contribute To Solr + +Thank you for your interest in contributing to the Apache Solr project. Solr continues to improve via the many contributions of developers around the world and new contributions are welcomed and encouraged. + +Your suggestions, comments and comments on Doris can be made directly through the [Apache Solr JIRA](https://issues.apache.org/jira/projects/SOLR/issues). + +There are many ways to participate in and contribute to Solr, such as: code implementation, test implementation, documentation improvements. + +If you have any questions along the way, you can reach out to the community using the resources provided [here](https://solr.apache.org/community.html#mailing-lists-chat). + +## How To Contribute + +Information on how to contribute can be found [here](https://github.com/apache/solr/blob/main/dev-docs/how-to-contribute.adoc). + +## Contributing Documentation + +One very helpful area for contribution to Solr is via documentation improvements and additions to help make Solr easier to use for others. You can read more about how to modify and update Solr documentation [here](https://github.com/apache/solr/blob/main/solr/solr-ref-guide/README.adoc). + +## Working With Solr Source Code + +Information on how to work with Solr source code and the build system can be found [here](https://github.com/apache/solr/blob/main/dev-docs/solr-source-code.adoc). + +## IDE Support + +Information on IDE support can be found [here](https://github.com/apache/solr/blob/main/dev-docs/IDEs.adoc). Review Comment: Same comment about 'here' applies ########## CONTRIBUTING.md: ########## @@ -0,0 +1,34 @@ +# Contribute To Solr + +Thank you for your interest in contributing to the Apache Solr project. Solr continues to improve via the many contributions of developers around the world and new contributions are welcomed and encouraged. + +Your suggestions, comments and comments on Doris can be made directly through the [Apache Solr JIRA](https://issues.apache.org/jira/projects/SOLR/issues). + +There are many ways to participate in and contribute to Solr, such as: code implementation, test implementation, documentation improvements. + +If you have any questions along the way, you can reach out to the community using the resources provided [here](https://solr.apache.org/community.html#mailing-lists-chat). + +## How To Contribute + +Information on how to contribute can be found [here](https://github.com/apache/solr/blob/main/dev-docs/how-to-contribute.adoc). + +## Contributing Documentation + +One very helpful area for contribution to Solr is via documentation improvements and additions to help make Solr easier to use for others. You can read more about how to modify and update Solr documentation [here](https://github.com/apache/solr/blob/main/solr/solr-ref-guide/README.adoc). + +## Working With Solr Source Code + +Information on how to work with Solr source code and the build system can be found [here](https://github.com/apache/solr/blob/main/dev-docs/solr-source-code.adoc). Review Comment: ```suggestion Information on how to work with Solr source code and the build system can be found in the [developer documentation](https://github.com/apache/solr/blob/main/dev-docs/solr-source-code.adoc). ``` ########## CONTRIBUTING.md: ########## @@ -0,0 +1,34 @@ +# Contribute To Solr + +Thank you for your interest in contributing to the Apache Solr project. Solr continues to improve via the many contributions of developers around the world and new contributions are welcomed and encouraged. + +Your suggestions, comments and comments on Doris can be made directly through the [Apache Solr JIRA](https://issues.apache.org/jira/projects/SOLR/issues). + +There are many ways to participate in and contribute to Solr, such as: code implementation, test implementation, documentation improvements. + +If you have any questions along the way, you can reach out to the community using the resources provided [here](https://solr.apache.org/community.html#mailing-lists-chat). + +## How To Contribute + +Information on how to contribute can be found [here](https://github.com/apache/solr/blob/main/dev-docs/how-to-contribute.adoc). + +## Contributing Documentation + +One very helpful area for contribution to Solr is via documentation improvements and additions to help make Solr easier to use for others. You can read more about how to modify and update Solr documentation [here](https://github.com/apache/solr/blob/main/solr/solr-ref-guide/README.adoc). + +## Working With Solr Source Code + +Information on how to work with Solr source code and the build system can be found [here](https://github.com/apache/solr/blob/main/dev-docs/solr-source-code.adoc). + +## IDE Support + +Information on IDE support can be found [here](https://github.com/apache/solr/blob/main/dev-docs/IDEs.adoc). + +## JVM Support + +Information on JVMs can be found [here](https://github.com/apache/solr/blob/main/dev-docs/jvms.adoc). + +## FAQs + +Review FAQs [here](https://github.com/apache/solr/blob/main/dev-docs/FAQ.adoc) Review Comment: Same comment about 'here' applies. BTW: Is this FAQ really up to date? If not, better not link to it? ########## dev-docs/how-to-contribute.adoc: ########## @@ -0,0 +1,23 @@ +# How To Contribute + +The Apache Solr Github Repository is located here: https://github.com/apache/solr. Typically all contributions to Solr are developed on a fork of the Solr repository, then opened as PRs against the `main` branch in the solr repository. These PRs are then linked to an open JIRA issue and members of the community will review, comment, approve, and commit changes. + +Please keep in mind that the Solr is community driven with many members taking their own personal time to help respond to issue and review PRs. Be open to feedback and discussions and maintain a respectful approach. + +## Setup for Contributing +In order to get setup you will need a fork of the Apache Solr repository and an account in the ASF Jira (usable for all Apache projects). + +1. Create a fork of the https://github.com/apache/solr[Solr repository] into your own personal account or a your corporate organization account using the Github instructions provided here: https://docs.github.com/en/get-started/quickstart/fork-a-repo. +2. Create an account in the ASF Jira: https://issues.apache.org/jira/login.jsp which you will use to create new issues. + +## Making a New Contribution +In order to make a new contribution to Solr you will use the fork you have created above. + +1. Create a new Jira issue in the Solr project: https://issues.apache.org/jira/projects/SOLR/issues +2. Create a new branch in your Solr fork to provide a PR for your contribution on the newly created issue. Make any necessary changes for the given bug/feature in that branch. You can use additional information in these dev-docs to build and test your code as well as ensure it passes code quality checks. +3. Once you are satisfied with your changes, open a PR of your branch against the `main` branch of the apache/solr repository. When you open a PR on your fork, this should be the default option. +* The title of your PR should include the Solr Jira issue that you opened, i.e. `SOLR-12345: New feature`. +* The PR description will automatically populate with a pre-set template that you will need to fill out. +* The PR will run a gradle pre-commit task that will do some basic checks of your changes. This is run as a Github Action and the results can be viewed from your PR. +* If you properly named your PR you will see it automatically linked to your Jira issue when you view the issue. +4. At this point, you will need a Solr committer to review your change and help to get it merged upstream. You can use the https://solr.apache.org/community.html[Solr Developers Mailing List] to get attention to your issue. Review Comment: Should we mention PR draft state? It can be useful if you know there is more work to do... ########## dev-docs/how-to-contribute.adoc: ########## @@ -0,0 +1,23 @@ +# How To Contribute + +The Apache Solr Github Repository is located here: https://github.com/apache/solr. Typically all contributions to Solr are developed on a fork of the Solr repository, then opened as PRs against the `main` branch in the solr repository. These PRs are then linked to an open JIRA issue and members of the community will review, comment, approve, and commit changes. + +Please keep in mind that the Solr is community driven with many members taking their own personal time to help respond to issue and review PRs. Be open to feedback and discussions and maintain a respectful approach. + +## Setup for Contributing +In order to get setup you will need a fork of the Apache Solr repository and an account in the ASF Jira (usable for all Apache projects). + +1. Create a fork of the https://github.com/apache/solr[Solr repository] into your own personal account or a your corporate organization account using the Github instructions provided here: https://docs.github.com/en/get-started/quickstart/fork-a-repo. +2. Create an account in the ASF Jira: https://issues.apache.org/jira/login.jsp which you will use to create new issues. Review Comment: Currently users have to request an account through the mailing lists... ########## CONTRIBUTING.md: ########## @@ -0,0 +1,34 @@ +# Contribute To Solr + +Thank you for your interest in contributing to the Apache Solr project. Solr continues to improve via the many contributions of developers around the world and new contributions are welcomed and encouraged. + +Your suggestions, comments and comments on Doris can be made directly through the [Apache Solr JIRA](https://issues.apache.org/jira/projects/SOLR/issues). + +There are many ways to participate in and contribute to Solr, such as: code implementation, test implementation, documentation improvements. + +If you have any questions along the way, you can reach out to the community using the resources provided [here](https://solr.apache.org/community.html#mailing-lists-chat). + +## How To Contribute + +Information on how to contribute can be found [here](https://github.com/apache/solr/blob/main/dev-docs/how-to-contribute.adoc). + +## Contributing Documentation + +One very helpful area for contribution to Solr is via documentation improvements and additions to help make Solr easier to use for others. You can read more about how to modify and update Solr documentation [here](https://github.com/apache/solr/blob/main/solr/solr-ref-guide/README.adoc). + +## Working With Solr Source Code + +Information on how to work with Solr source code and the build system can be found [here](https://github.com/apache/solr/blob/main/dev-docs/solr-source-code.adoc). + +## IDE Support + +Information on IDE support can be found [here](https://github.com/apache/solr/blob/main/dev-docs/IDEs.adoc). + +## JVM Support + +Information on JVMs can be found [here](https://github.com/apache/solr/blob/main/dev-docs/jvms.adoc). Review Comment: Same comment about 'here' applies ########## dev-docs/solr-source-code.adoc: ########## @@ -0,0 +1,76 @@ +# Working With Solr Source Code + +## Building Solr from Source + +Download the Java 11 JDK (Java Development Kit) or later. We recommend the OpenJDK +distribution Eclipse Temurin available from https://adoptium.net/. +You will need the JDK installed, and the $JAVA_HOME/bin (Windows: %JAVA_HOME%\bin) +folder included on your command path. To test this, issue a "java -version" command +from your shell (command prompt) and verify that the Java version is 11 or later. See https://github.com/apache/solr/blob/main/dev-docs/jvms.adoc[here] for more information on Gradle and JVMs. + +Download the Apache Solr distribution, from https://solr.apache.org/downloads.html. +Unzip the distribution to a folder of your choice, e.g. C:\solr or ~/solr +Alternately, you can obtain a copy of the latest Apache Solr source code Review Comment: Should not git be the first option we mention, and "Alternatively you can download the source..."? ########## dev-docs/how-to-contribute.adoc: ########## @@ -0,0 +1,23 @@ +# How To Contribute + +The Apache Solr Github Repository is located here: https://github.com/apache/solr. Typically all contributions to Solr are developed on a fork of the Solr repository, then opened as PRs against the `main` branch in the solr repository. These PRs are then linked to an open JIRA issue and members of the community will review, comment, approve, and commit changes. + +Please keep in mind that the Solr is community driven with many members taking their own personal time to help respond to issue and review PRs. Be open to feedback and discussions and maintain a respectful approach. + +## Setup for Contributing +In order to get setup you will need a fork of the Apache Solr repository and an account in the ASF Jira (usable for all Apache projects). + +1. Create a fork of the https://github.com/apache/solr[Solr repository] into your own personal account or a your corporate organization account using the Github instructions provided here: https://docs.github.com/en/get-started/quickstart/fork-a-repo. +2. Create an account in the ASF Jira: https://issues.apache.org/jira/login.jsp which you will use to create new issues. + +## Making a New Contribution +In order to make a new contribution to Solr you will use the fork you have created above. + +1. Create a new Jira issue in the Solr project: https://issues.apache.org/jira/projects/SOLR/issues +2. Create a new branch in your Solr fork to provide a PR for your contribution on the newly created issue. Make any necessary changes for the given bug/feature in that branch. You can use additional information in these dev-docs to build and test your code as well as ensure it passes code quality checks. +3. Once you are satisfied with your changes, open a PR of your branch against the `main` branch of the apache/solr repository. When you open a PR on your fork, this should be the default option. Review Comment: Before opening a PR it is useful to run `tidy` and `check -x test` for a shorter feedback loop. Sometimes `updateLicenses` is also needed, so the easiest is to fold all three into one: ```suggestion 3. Once you are satisfied with your changes, get your branch ready for a PR by running `./gradlew tidy updateLicenses check -x test`. This will format your source code, update licenses of any dependency version changes and run all pre-commit tests. Commit the changes. 4. Open a PR of your branch against the `main` branch of the apache/solr repository. When you open a PR on your fork, this should be the default option. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org For additional commands, e-mail: issues-h...@solr.apache.org
