You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@lucene.apache.org by GitBox <gi...@apache.org> on 2022/04/11 15:40:10 UTC
[GitHub] [lucene] rbowen opened a new pull request, #808: LUCENE-10513: Run `gradlew tidy` first
rbowen opened a new pull request, #808:
URL: https://github.com/apache/lucene/pull/808
Encourage running `gradlew tidy` first, which, in turn, prevents failures in later steps.
# Description
In contributing my first change, I encountered formatting advice that would have been rendered unnecessary if I had first run `gradlew tidy`
# Solution
Recommend `gradlew tidy` as first step of workflow.
# Tests
Docs-only change - no tests.
# Checklist
Please review the following and check all that apply:
- [x ] I have reviewed the guidelines for [How to Contribute](https://github.com/apache/lucene/blob/main/CONTRIBUTING.md) and my code conforms to the standards described there to the best of my ability.
- [x ] I have created a Jira issue and added the issue ID to my pull request title.
- [ ] I have given Lucene maintainers [access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork) to contribute to my PR branch. (optional but recommended)
- [x ] I have developed this patch against the `main` branch.
- [x ] I have run `./gradlew check`.
- [ ] I have added tests for my changes.
--
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-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] mocobeta commented on pull request #808: LUCENE-10513: Run `gradlew tidy` first
Posted by GitBox <gi...@apache.org>.
mocobeta commented on PR #808:
URL: https://github.com/apache/lucene/pull/808#issuecomment-1102669627
I didn't know the figure, it's very simple and helpful, thanks! I'll read the article next holidays.
> I have been capitalizing it ever since I learned it but I will try to stop.
It looks that the word Shoshin may already have a special or cultural meaning in English, so capitalization may be needed to express the nuance that the original Japanese word doesn't have? :)
--
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-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] rbowen commented on pull request #808: LUCENE-10513: Run `gradlew tidy` first
Posted by GitBox <gi...@apache.org>.
rbowen commented on PR #808:
URL: https://github.com/apache/lucene/pull/808#issuecomment-1096660870
Thank you!
--
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-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] dweiss commented on pull request #808: LUCENE-10513: Run `gradlew tidy` first
Posted by GitBox <gi...@apache.org>.
dweiss commented on PR #808:
URL: https://github.com/apache/lucene/pull/808#issuecomment-1098327441
LGTM, thanks!
--
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-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] mocobeta merged pull request #808: LUCENE-10513: Run `gradlew tidy` first
Posted by GitBox <gi...@apache.org>.
mocobeta merged PR #808:
URL: https://github.com/apache/lucene/pull/808
--
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-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] mocobeta commented on pull request #808: LUCENE-10513: Run `gradlew tidy` first
Posted by GitBox <gi...@apache.org>.
mocobeta commented on PR #808:
URL: https://github.com/apache/lucene/pull/808#issuecomment-1102598934
oh, I learned that wikipedia has an article on Shoshin (初心) for the first time. It's a common noun in Japanese (and also in Chinese I think) so there are no corresponding articles in those languages; I can't really explain it, but it's interesting to me the word is capitalized like proper nouns...
--
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-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] mikemccand commented on pull request #808: LUCENE-10513: Run `gradlew tidy` first
Posted by GitBox <gi...@apache.org>.
mikemccand commented on PR #808:
URL: https://github.com/apache/lucene/pull/808#issuecomment-1102642347
> oh, I learned that wikipedia has an article on Shoshin (初心) for the first time. It's a common noun in Japanese (and also in Chinese I think) so there are no corresponding articles in those languages; I can't really explain it, but it's interesting to me the word is capitalized like proper nouns...
Oh thanks for explaining @mocobeta! I have been capitalizing it ever since I learned it but I will try to stop. Maybe I can just use 初心 going forwards. Thanks!
shoshin (初心) also reminds of this helpful graph (from WaitButWhy's [The Thinking Ladder](https://waitbutwhy.com/2019/09/thinking-ladder.html)):
--
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-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] dweiss commented on pull request #808: LUCENE-10513: Run `gradlew tidy` first
Posted by GitBox <gi...@apache.org>.
dweiss commented on PR #808:
URL: https://github.com/apache/lucene/pull/808#issuecomment-1095406753
I allowed myself to push minor changes to your branch, including what @rmuir suggested, which indeed seems like an omission.
--
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-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] mocobeta commented on pull request #808: LUCENE-10513: Run `gradlew tidy` first
Posted by GitBox <gi...@apache.org>.
mocobeta commented on PR #808:
URL: https://github.com/apache/lucene/pull/808#issuecomment-1097561253
I made minor edits to the contribution guide without losing the information added here.
https://github.com/apache/lucene/commit/e6fb74f9090db2bc274af94c17d80739697bdc01
I think I'm too accustomed to the development workflow on this project, so I'm not able to figure out what is the minimum information that should be shown there to introduce new contributors without unnecessary pain or asking "newbie" questions to committers - feedback is welcome.
--
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-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] mikemccand commented on pull request #808: LUCENE-10513: Run `gradlew tidy` first
Posted by GitBox <gi...@apache.org>.
mikemccand commented on PR #808:
URL: https://github.com/apache/lucene/pull/808#issuecomment-1101418928
> I think I'm too accustomed to the development workflow on this project, so I'm not able to figure out what is the minimum information that should be shown there to introduce new contributors without unnecessary pain or asking "newbie" questions to committers - feedback is welcome.
This happens to all of us :) We lose our fresh eyes / beginner's mind / [Shoshin](https://en.wikipedia.org/wiki/Shoshin). It is a sharp tool that quickly dulls, unfortunately.
We old-timers must constantly strive to aggressively encourage the new people that grow the periphery of our community so we can learn from their experiences and make it better for the next new members. We are too API-blind or missing-stair to do this ourselves.
--
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-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] rmuir commented on pull request #808: LUCENE-10513: Run `gradlew tidy` first
Posted by GitBox <gi...@apache.org>.
rmuir commented on PR #808:
URL: https://github.com/apache/lucene/pull/808#issuecomment-1095247184
Thanks for following up here! These changes look fine. I'm wondering if there's anything we could improve in the CONTRIBUTING.md to make this easier, too, maybe something in "checks" section. maybe it is as simple as adding some markdown-links to this file to reference appropriate stuff in help/.
Currently, CONTRIBUTING.md doesn't mention a thing about code formatting directly... which doesn't seem right to me.
--
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-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] mocobeta commented on pull request #808: LUCENE-10513: Run `gradlew tidy` first
Posted by GitBox <gi...@apache.org>.
mocobeta commented on PR #808:
URL: https://github.com/apache/lucene/pull/808#issuecomment-1096056476
Elaborating CONTRIBUTING.md might be good, on the other hand, we also makes it wordy and increase the maintenance cost (I know few people care about it, then it'd easily become out-of-date).
Just an idea but how about removing the entire `Checks` section and just mentioning `gradlew helpWorkflow`...
--
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-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] mikemccand commented on pull request #808: LUCENE-10513: Run `gradlew tidy` first
Posted by GitBox <gi...@apache.org>.
mikemccand commented on PR #808:
URL: https://github.com/apache/lucene/pull/808#issuecomment-1101417096
> I followed the commits and I think it shouldn't be the main concern here to edit `CONTRIBUTIONG.md`? I'm not going to be against or hold this. Maybe I'll open another follow-up PR for it; please go ahead.
+1 to make it a priority to keep `CONTRIBUTING.md` succint.
--
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-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org