Added Hyperlinks in Ways to Contribute Section by anishfyi · Pull Request #302 · anitab-org/anitab-org.github.io

anishfyi · 2021-10-16T19:33:53Z

Description

Added Relevant Hyperlinks In Ways To Contribute Section

Text : "Creating issues on GitHub", Link : https://github.com/anitab-org/anitab-org.github.io/issues
Text : "First Timers", Link : https://github.com/anitab-org/anitab-org.github.io/issues?q=is%3Aopen+is%3Aissue+label%3A%22First+Timers+Only%22
Text : "Commit Message Style Guide", Link : https://github.com/anitab-org/mentorship-android/wiki/Commit-Message-Style-Guide
Q - Why Use HTML React Parser ?
A - Initially The Content Was Text, So React Could Easily Parse Text and Convert it To Equivalent Text Nodes but in Case You Have Any HTML Content Coming Inside the Content, We Needed to Help React To Parse The Content to be Treated as Valid and HTML Tags Passed To Be Converted To React Nodes, We Needed HTMLReactParser Which Converts HTML Tags To Equivalent React Nodes.
We Had Two Options 1.) dangerouslysetInnerHtml 2.) Third Party Library HTMLReactParser.
I Chose to Use HTMLReactParser because dangerouslyInnerHtml has some security concern and react may discard it in future versions, Thereby Used HTMLReactParser

Fixes #299

Hyperlinks Added

Type of Change:

Code

Checklist:

My PR follows the style guidelines of this project
I have performed a self-review of my own code or materials

Code/Quality Assurance Only

My changes generate no new warnings

isabelcosta · 2021-10-17T13:04:39Z

@daxoron I edited your PR description, to include Fixes #299 because in this way it gets linked to your issue, and once this gets merged, that will get closed. This is also important, for me to see that you submitted a PR related to the correct issue. Please consider this for future PRs, it helps maintainers a lot 🤗

isabelcosta

Nice work @daxoron !
Thank you for contributing 🙌🏾

isabelcosta · 2021-10-17T13:05:33Z

src/Components/Home/index.js

        <SectionSubheader title={section.title} />
        {section.content.map((content, indx) => {
-          return <Description key={indx}>{content.par}</Description>;
+          return <Description key={indx}>{HTMLReactParser(content.par)}</Description>;


this was needed to make text linkable right?

@isabelcosta, Initially The Content Was Text, So React Could Easily Parse Text and Convert it To Equivalent Text Nodes but in Case You Have Any HTML Content Coming Inside the Content, We Needed to Help React To Parse The Content to be Treated as Valid and HTML Tags Passed To Be Converted To React Nodes, We Needed HTMLReactParser Which Converts HTML Tags To Equivalent React Nodes.

We Had Two Options 1.) dangerouslysetInnerHtml 2.) Third Party Library HTMLReactParser.

I Chose to Use HTMLReactParser because dangerouslyInnerHtml has some security concern and react may discard it in future versions, Thereby Used HTMLReactParser

isabelcosta · 2021-10-17T17:13:48Z

@daxoron thank you for adding more context! Could you also fix the merge conflicts please 🙏🏾 I will request more reviews to get this approved :)

vj-codes · 2021-10-17T17:18:21Z

src/content/home.js

          par:
-            "Each active repository has a stream to direct questions. \nIssues labeled as 'First Timers Only' are meant for contributors who have not contributed to the project yet. Please choose other issues to contribute to, if you have already contributed to these type of issues. \nMake sure to follow the Commit Message Style Guide when submitting PRs which will require review by at least one maintainer to be merged to the main code.",
+            'Each active repository has a stream to direct questions. \nIssues labeled as <a href = "https://github.com/anitab-org/anitab-org.github.io/issues?q=is%3Aopen+is%3Aissue+label%3A%22First+Timers+Only%22" target="_blank">First Timers</a> Only are meant for contributors who have not contributed to the project yet. Please choose other issues to contribute to, if you have already contributed to these type of issues. \nMake sure to follow the <a href = "https://github.com/anitab-org/mentorship-android/wiki/Commit-Message-Style-Guide" target="_blank">Commit Message Style Guide</a> when submitting PRs which will require review by at least one maintainer to be merged to the main code.',
        },


@daxoron can you update the hyperlinked text to "First Timers Only", right now it's just First Timers
Once done, this PR is good to go 🚀

Also there are some conflicts, please resolve them as well

@vj-codes Sure, Doing It Right Now.

@vj-codes Done. Modified Text and Resolved the Merge Conflicts.

anishfyi · 2021-10-17T17:39:38Z

@vj-codes @isabelcosta Merge Conflicts Resolved, Please Review and Merge.

vj-codes

@daxoron Congratulations on your first contribution to the repository 🎉
LGMT!

isabelcosta · 2021-10-17T19:20:41Z

@daxoron can you please check why the PR checks are failing? And hopefully, fix them 🤔

anishfyi · 2021-10-17T19:54:28Z

@daxoron can you please check why the PR checks are failing? And hopefully, fix them 🤔

Yes, Checking Right Away 👍🏻

Will Make Necessary Changes by The End Of The Day 👍🏻

isabelcosta · 2021-10-17T20:32:20Z

No urgency here @daxoron :)

isabelcosta · 2021-10-17T23:35:05Z

.github/workflows/deploy.yml

+        with:
+          # Make sure the actual branch is checked out when running on pull requests
+          ref: ${{ github.event.pull_request.base.ref }}
+
+          # This is important to fetch the changes to the previous commit
+          fetch-depth: 0


hopefully, the changes to this file won't be needed, as these are already on their way in this pull request #305. Could you take a look, and if you agree with the changes leave an approval @daxoron ?

@isabelcosta its just a draft change because of the recent prettier change, My PR Checks Were Failing and nothing due to my code.
Will Update within sometime for the final change.

yes, I understand :) If these changes help you and you approve the other PR, I can go ahead and merge it, and then you can get that change in your PR 😉 @daxoron

@isabelcosta I Have Made Some Final Changes in deploy.yml aswell.
I Had A Look on #305 PR but those changes were not working with my PR.
So I have made the required changes and have a look and both #305 and #302 can be closed with my PR.

anishfyi · 2021-10-18T13:43:13Z

@isabelcosta My PR Checks Will Pass if #305 Gets Merged.
👍🏻

isabelcosta · 2021-10-18T13:56:06Z

The changes made in this PR were tested locally. Following are the results:

Code review - Done
All possible responses (positive and negative tests) were tested as below:
- Run and open homepage
  Screenshot/gif:
  
  Expected Result: There should be hyperlinks in the "Ways to Contribute" section of the Homepage
  Actual Result: Verified, it works as expected. I can click parts of the "Ways to Contribute" section. The links take me to a new tab.
  ...
Additional comments: N/A
Status of PR Changed to: Ready to Merge.

isabelcosta · 2021-10-18T13:57:33Z

Thank you @daxoron for collaborating with @ftonato to get this completed 💪🏾
Really love to see this!

anishfyi · 2021-10-18T13:59:24Z

@isabelcosta Thank You For Assigning Me this Task.
Learned Alot and Thanks For Replying to Every Doubts of Mine :)

Added Hyperlinks in Ways to Contribute Section

9b7ffc3

isabelcosta approved these changes Oct 17, 2021

View reviewed changes

isabelcosta requested review from Aaishpra, Amulya-coder and Rahulm2310 October 17, 2021 13:06

vj-codes requested changes Oct 17, 2021

View reviewed changes

vj-codes added the Status: Changes Requested Changes are required to be done by the PR author. label Oct 17, 2021

Merge Conflicts Resolved

fbfd645

First Timers Text Changed

e14822f

anishfyi requested review from isabelcosta and vj-codes October 17, 2021 17:50

vj-codes approved these changes Oct 17, 2021

View reviewed changes

daxoron and others added 9 commits October 18, 2021 04:11

Code Modified based on Prettier

7254195

Merge branch 'anitab-org:develop' into hyperlink-contribution

8219cad

deploy.yaml Changes - Testing

c6d2d9a

deploy.yaml Changes - Testing

fd5a874

deploy.yaml Changes - Testing

12d9da8

Reverted deploy.yml

ae394a8

homepage Snapshot Updated

b0a1d41

deploy.yml Changes - Testing

547dfd3

deploy.yml Changes - Testing

3117529

isabelcosta reviewed Oct 17, 2021

View reviewed changes

daxoron added 2 commits October 18, 2021 05:06

deploy.yml Changes - Testing

4759b6b

deploy.yml Changes - Testing

41fe445

deploy.yml Changes - Final

c64fa1f

anishfyi mentioned this pull request Oct 17, 2021

chore: update action to ensure we get the reference before running "prettier" #305

Merged

Deploy.yml Reverted Back Draft

98afe38

Merge branch 'anitab-org:develop' into hyperlink-contribution

f961abc

isabelcosta added Status: Needs Testing Work has been reviewed and needs the code tested by the quality assurance team. and removed Status: Changes Requested Changes are required to be done by the PR author. labels Oct 18, 2021

isabelcosta added Status: Ready to Merge Work has been tested and needs a final review and merge from a repo maintainer. and removed Status: Needs Testing Work has been reviewed and needs the code tested by the quality assurance team. labels Oct 18, 2021

isabelcosta merged commit 4b63457 into anitab-org:develop Oct 18, 2021

anishfyi deleted the hyperlink-contribution branch October 18, 2021 14:31

ftonato pushed a commit to ftonato/anitab-org.github.io that referenced this pull request Oct 19, 2021

feat: add hyperlinks in Ways to Contribute home section (anitab-org#302)

7522b7f

Conversation

anishfyi commented Oct 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of Change:

Checklist:

Uh oh!

isabelcosta commented Oct 17, 2021

Uh oh!

isabelcosta left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

isabelcosta commented Oct 17, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anishfyi commented Oct 17, 2021

Uh oh!

vj-codes left a comment

Choose a reason for hiding this comment

Uh oh!

isabelcosta commented Oct 17, 2021

Uh oh!

anishfyi commented Oct 17, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

isabelcosta commented Oct 17, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anishfyi commented Oct 18, 2021

Uh oh!

isabelcosta commented Oct 18, 2021

Uh oh!

isabelcosta commented Oct 18, 2021

Uh oh!

anishfyi commented Oct 18, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

anishfyi commented Oct 16, 2021 •

edited

Loading

anishfyi commented Oct 17, 2021 •

edited

Loading