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 typo in How to Contribute docs. #7614

Merged
merged 1 commit into from Apr 24, 2019

Conversation

Projects
None yet
3 participants
@rusrushal13
Copy link
Contributor

commented Apr 23, 2019

Problem

The typo mistake in how to contribute doc.
image

Solution

Corrected the typo by changing the respective file.

Result

Now the link won't be visible instead the text will be having the hyperlink.
image

@Eric-Arellano
Copy link
Contributor

left a comment

Thanks @rusrushal13!

Only feedback is on documenting the change. With PR titles, we tend to start them with a verb like Fix or Add ability etc. Here, a good title might be Fix typo in How To Contribute docs.

For the description itself, it looks like you're using the Problem, Solution, Resolution setup, which is good, but that you removed the headers for those sections. It would be helpful to restore those headers that start with ###. Including a screenshot of the original bad docs in the Problem section would be great too.

@codealchemy
Copy link
Contributor

left a comment

👍

@rusrushal13 rusrushal13 changed the title How to Contribute Typo Fix typo in How to Contribute docs. Apr 23, 2019

@rusrushal13

This comment has been minimized.

Copy link
Contributor Author

commented Apr 23, 2019

Thanks, @Eric-Arellano for the feedback.

I included the screenshot for both, the problem statement and the result.

@Eric-Arellano
Copy link
Contributor

left a comment

Looks great!

Our CI currently fails due to an upstream issue from the Rustup tool that started happening this morning. Don't be alarmed that CI is going to fail currently for this PR for this reason.

I will merge this once we get CI resolved in master, and then run our script to publish docs. Thanks again!

@rusrushal13

This comment has been minimized.

Copy link
Contributor Author

commented Apr 23, 2019

Thanks, @Eric-Arellano 😄

@Eric-Arellano

This comment has been minimized.

Copy link
Contributor

commented Apr 24, 2019

Skipping CI on this as it's solely a doc change. Congrats @rusrushal13 on your first PR 🎉

Will ping you on Slack once we get this published.

@Eric-Arellano Eric-Arellano merged commit cc04c08 into pantsbuild:master Apr 24, 2019

1 check failed

continuous-integration/travis-ci/pr The Travis CI build failed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.