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.

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

Fix Breaking-link Punctuation at end of URL in Comments #10947

Closed
5 tasks
PeculiarE opened this issue Apr 5, 2022 · 16 comments · Fixed by #11048
Closed
5 tasks

Fix Breaking-link Punctuation at end of URL in Comments #10947

PeculiarE opened this issue Apr 5, 2022 · 16 comments · Fixed by #11048
Labels
first-timers-only They need to be well-formatted using the First-timers_Issue_Template.

Comments

@PeculiarE
Copy link
Contributor

PeculiarE commented Apr 5, 2022

Hi, this is a first-timers-only issue and fixing it will resolve part of the issue in #10944. We've worked to make it more legible to folks who either haven't contributed to our codebase before, or even folks who haven't contributed to open source before.

If that's you, we're interested in helping you take the first step and can answer questions and help you out as you do. Note that we're especially interested in contributions from people from groups underrepresented in free and open source software!

We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝

If you have contributed before, consider leaving this one for someone new and looking through our general help wanted issues. Thanks!

🤔 What you will need to know.

Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.

📋 Step by Step

  • 🙋 Claim this issue: Claim the issue by commenting. If someone else has claimed it, ask if they've opened a pull request already and if they're stuck -- maybe you can help them solve a problem or move it along!
💡 Learn how to claim 🙋

Claiming an issue

Unless the issue is marked as reserved for someone, you can just say "I'd like to try this!" and then you've claimed it - no need to wait for someone to assign it to you. Just be sure you link your pull request (PR) to this issue so we can see where your solution is.

And open one early if possible - even before you've completed it with additional commits - and others can help you figure out any issues you may face.

  • 📝 Update the files specified below in the plots2 repository (press the little pen Icon) and edit the line as shown below.

See this page for some help in taking your first steps!

Below is a "diff" showing in red (and a -) which lines to remove, and in green (and a +) which lines to add:

1st file to be changed: comment.rb

def render_body
-    body = RDiscount.new(
-      title_suggestion(self),
-      :autolink
-    ).to_html
+    body = RDiscount.new(title_suggestion(self)).to_html
     # if it has quoted email text that wasn't caught by the yahoo and gmail filters,
     # manually insert the comment filter delimeter:
     parsed = parse_quoted_text

2nd file to be changed: _comment.html.erb

<% comment_body = comment.render_body %>
     <div class="comment-body" id="comment-body-<%= comment.cid %>">
-      <%= raw insert_extras(filtered_comment_body(comment_body)) %>
+      <%= raw auto_link(insert_extras(filtered_comment_body(comment_body)), :sanitize => false) %>
     </div>
  • 💾 Commit your changes

  • 🔀 Start a Pull Request. There are two ways how you can start a pull request:

  1. If you are familiar with the terminal or would like to learn it, here is a great tutorial on how to send a pull request using the terminal.

  2. You can also edit files directly in your browser and open a pull request from there.

  • 🏁 Done Ask in comments for a review :)

Please keep us updated

💬⏰ - We encourage contributors to be respectful to the community and provide an update within a week of claiming a first-timers-only issue. We're happy to keep it assigned to you as long as you need if you update us with a request for more time or help, but if we don't see any activity a week after you claim it we may reassign it to give someone else a chance. Thank you in advance!

If this happens to you, don't sweat it! Grab another open issue.

Is someone else already working on this?

🔗- We encourage contributors to link to the original issue in their pull request so all users can easily see if someone's already started on it.

👥- If someone seems stuck, offer them some help! Otherwise, take a look at some other issues you can help with. Thanks!

🤔❓ Questions?

Leave a comment below, and reach out in our chatroom!

@PeculiarE PeculiarE added the fto-candidate issues which are meant to be solved by first timers but aren't well-formatted yet label Apr 5, 2022
@welcome
Copy link

welcome bot commented Apr 5, 2022

Thanks for opening your first issue! This space is protected by our Code of Conduct - and we're here to help.
Please follow the issue template to help us help you 👍🎉😄
If you have screenshots or a gif to share demonstrating the issue, that's really helpful! 📸
Do join our Gitter channel for some brainstorming discussions.

@PeculiarE PeculiarE changed the title Fix Breaking-link Punctuation at end of URL Fix Breaking-link Punctuation at end of URL in Comments Apr 5, 2022
@PeculiarE
Copy link
Contributor Author

PeculiarE commented Apr 5, 2022

Hi @jywarren. Please help review 😄.

I'm not so sure if and how I should reference the original issue.

Update: I have been able to link both issues 😄

@on2onyekachi
Copy link

Great! @PeculiarE

@PeculiarE
Copy link
Contributor Author

Thank you @on2onyekachi 😃

@TildaDares
Copy link
Member

Thanks for working on this @PeculiarE. Thank you!!

@TildaDares
Copy link
Member

Reserved for @rajvidg for 24 hours!!

@TildaDares TildaDares added first-timers-only They need to be well-formatted using the First-timers_Issue_Template. and removed fto-candidate issues which are meant to be solved by first timers but aren't well-formatted yet labels Apr 8, 2022
@rajvidg
Copy link
Contributor

rajvidg commented Apr 8, 2022

Reserved for @rajvidg for 24 hours!!

Thank you @TildaDares , I've started to work on it. :)

@rajvidg
Copy link
Contributor

rajvidg commented Apr 8, 2022

I updated both of the files, please check for a review. @TildaDares

@jywarren
Copy link
Member

Hi @rajvidg can you link us to your pull request so we can check? Thank you!!

@TildaDares
Copy link
Member

Hi @PeculiarE Is there an update to this issue?

@PeculiarE
Copy link
Contributor Author

PeculiarE commented Apr 15, 2022

Hi @TildaDares, the fix in this FTO doesn't cater for the React comment rendering system. @jywarren and I looked into fixing that (please see the original issue and conversation here: #10944) and I believe we've got it figured out plus I've tested the fix locally.

Maybe this issue can be closed (since the broken link in the normal commenting system has actually been fixed), and a separate FTO opened for the React system fix once we get a review/go-ahead from @jywarren. Does that work?

@rajvidg
Copy link
Contributor

rajvidg commented Apr 15, 2022

Hi @rajvidg can you link us to your pull request so we can check? Thank you!!

Sorry I missed this one :'( , I guess its done or should I do it now?

@PeculiarE
Copy link
Contributor Author

Hi @rajvidg....you've done it already 😄....Thank you for working on this ❤️

@rajvidg
Copy link
Contributor

rajvidg commented Apr 15, 2022

Hi @rajvidg....you've done it already 😄....Thank you for working on this ❤️

Oh, alright!, thank you for giving me a chance!! :)))

@PeculiarE
Copy link
Contributor Author

Hi @TildaDares, I believe we can merge @rajvidg's PR and close this issue. I've opened a new one at #11075 for the React version fix. Thank you 😄

@ebarry
Copy link
Member

ebarry commented May 10, 2022

Excited for this fix!

jywarren pushed a commit that referenced this issue May 29, 2022
#10947 (#11048)

* Added a line just for testing to the README file

* Update comment.rb

* Update _comment.html.erb

* Update README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
first-timers-only They need to be well-formatted using the First-timers_Issue_Template.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants