Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added a useful reference to the README #356

Merged
merged 3 commits into from
Sep 13, 2024
Merged

Added a useful reference to the README #356

merged 3 commits into from
Sep 13, 2024

Conversation

neboskreb
Copy link
Contributor

This PR addresses ticket #355

Please review and post your comments/corrections.

@neboskreb neboskreb mentioned this pull request Sep 6, 2024
Closed
mannodermaus
mannodermaus requested changes Sep 11, 2024
View reviewed changes
Copy link
Owner

@mannodermaus mannodermaus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your proposal! I have added comments along the way. But first of all, I'll have to introduce you to my weird decision to manage the readme in this project, sorry about that. 🫠

Instead of changing the readme file itself, you'll want to put any changes into the README.md.template file instead, and then run the generateReadme task from the IntelliJ/plugin project to generate the actual readme file.

I chose this approach because there are many version references in the readme, and I wanted to synchronize those with the codebase directly. There is a disclaimer at the top of the README.md file to detract people from changing it directly, but I'll concede that it's very very subtle and I must find a better way. 😆 Apologies for the hassle!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@neboskreb
Copy link
Contributor Author

BTW, please take a look at my README which mentions your repo several times. If any of those references not OK please let me know or rise a PR to rectify them.

mannodermaus
mannodermaus reviewed Sep 12, 2024
View reviewed changes
Copy link
Owner

@mannodermaus mannodermaus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thanks for updating it! I have the tiniest of whitespace adjustment requests, but after that we can merge this in. I have no issue whatsoever with the mentions in your README, it looks very clean. 👌

README.md.template Outdated Show resolved Hide resolved
build-logic/src/main/kotlin/Dependencies.kt Show resolved Hide resolved
neboskreb and others added 2 commits September 13, 2024 23:01
@neboskreb @mannodermaus
Line breaks
c4a5aa1 
Co-authored-by: Marcel Schnelle <marcelschnelle@aol.com>
@neboskreb
Generated the updated README
339f7bd
@neboskreb
Copy link
Contributor Author

Thanks for your suggestion!
I applied it and re-generated the README.
Pushed the branch, please check out.

@mannodermaus mannodermaus self-requested a review September 13, 2024 23:51
@mannodermaus
Copy link
Owner

Thank you for your contribution! 🙇‍♂️

@mannodermaus mannodermaus merged commit fb7c6ed into mannodermaus:main Sep 13, 2024
1 check passed
@neboskreb neboskreb deleted the feature/add-reference-to-instant-executor-extension branch September 14, 2024 09:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mannodermaus mannodermaus mannodermaus approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@neboskreb @mannodermaus