[META] Contributing Guide Revamp #24705
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
facebook-github-bot
added
CLA Signed
rickhanlonii
approved these changes
May 8, 2019
There was a problem hiding this comment.
Wow these docs are amazing, thanks @hramos!!
I left a bunch of minor comments for wording/formatting as I read, feel free to take any of the ones you like and reject any you don't 👍
.github/wiki/FirstPullRequest.md
Outdated
| @@ -0,0 +1,120 @@ | |||
| # Your First Pull Request, a Step-by-Step Guide | |||
|
|
|||
| These instructions provide the step-by-step process to set up your machine to make contributions to the core React Native repository, and create your first pull request. | |||
There was a problem hiding this comment.
Suggested change
| These instructions provide the step-by-step process to set up your machine to make contributions to the core React Native repository, and create your first pull request. | |
| These instructions provide a step-by-step process to set up your environment and create your first React Native pull request. |
- Minor re-wording
.github/wiki/FirstPullRequest.md
Outdated
|
|
||
| ### 2. Get the source code | ||
|
|
||
| While you can browse the source code for React Native on [GitHub][facebook/react-native], we recommend you set up a fork on your local machine. |
There was a problem hiding this comment.
Suggested change
| While you can browse the source code for React Native on [GitHub][facebook/react-native], we recommend you set up a fork on your local machine. | |
| While you can browse the source code for React Native on [GitHub][facebook/react-native], we recommend you set up a fork on your local machine: |
- Switch to colon
.github/wiki/FirstPullRequest.md
Outdated
|
|
||
| While you can browse the source code for React Native on [GitHub][facebook/react-native], we recommend you set up a fork on your local machine. | ||
|
|
||
| 1. Go to <https://github.com/facebook/react-native>. |
There was a problem hiding this comment.
Suggested change
| 1. Go to <https://github.com/facebook/react-native>. | |
| 1. Go to [https://github.com/facebook/react-native](https://github.com/facebook/react-native). |
- Convert to a link
.github/wiki/FirstPullRequest.md
Outdated
| 2. Click on Fork on the upper right. | ||
| 3. When asked, select your username as the host for this fork. | ||
|
|
||
| You will now have a fork of React Native on GitHub at <https://github.com/your_username/react-native>. Next, you will grab a copy of the source code for your local machine. Open a shell and type the following commands: |
There was a problem hiding this comment.
Suggested change
| You will now have a fork of React Native on GitHub at <https://github.com/your_username/react-native>. Next, you will grab a copy of the source code for your local machine. Open a shell and type the following commands: | |
| You will now have a fork of React Native on GitHub at <https://github.com/your_username/react-native> and can copy the source code for your local machine. | |
| Open a shell and type the following commands: |
- Whitespace and wording
Co-Authored-By: hramos <165856+hramos@users.noreply.github.com>
Co-Authored-By: hramos <165856+hramos@users.noreply.github.com>
…into contributing-master
|
I've updated the Quip I based these on with the latest suggestions. Let's use that to work on any changes, and then I'll come back here and add them to the PR. |
mokimo
reviewed
May 9, 2019
facebook-github-bot
approved these changes
May 10, 2019
There was a problem hiding this comment.
@hramos is landing this pull request. If you are a Facebook employee, you can view this diff on Phabricator.
|
This pull request was successfully merged by @hramos in a6f905f. When will my fix make it into a release? | Upcoming Releases |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This is the first step in revamping the Contribution Guide at
/CONTRIBUTING.md. This work will require changes to the React Native website repository, as well as the React Native GitHub wiki. For review purposes, changes to copy that exists outside of this repository will be included within a.github/wikidirectory in this PR, but they are not intended to be part of the final PR that gets merged.Changelog
[General] [Changed] - Contribution Guide Revamp
Test Plan
N/A