Update Contributing Docs #10165
Merged
Update Contributing Docs #10165
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
jlipps
reviewed
Feb 9, 2018
| npm install | ||
| gulp transpile | ||
| ``` | ||
| rm -rf node-modules && npm install |
There was a problem hiding this comment.
should we include package-lock.json in the rm?
There was a problem hiding this comment.
Good point. I'll add a little blurb. I think most repos now don't produce them, but I may have missed some.
There was a problem hiding this comment.
I also appear to have used node-modules instead of node_modules. So doubly good catch!
| ### JavaScript | ||
|
|
||
| With the exception of the code that runs on devices ([appium-uiautomator2-server](https://github.com/appium/appium-uiautomator2-server) for | ||
| Android, [WebDriverAgent](https://github.com/appium/WebDriverAgent) for iOS), Appium is written in [Node.js](). If you are |
There was a problem hiding this comment.
Good catch. I originally did this on an airplane with no interwebs, so had to leave the links blank and go back and fill in. Obviously I missed some. :(
imurchie
added a commit
that referenced
this pull request
Feb 15, 2018
* Update contributing docs * Fix some links and examples * Address comments
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.
Proposed changes
First pass at updating the contributing documentation. I am sure it will take more iterations to get it into a good state.
Types of changes
What types of changes does your code introduce to Appium?
Put an
xin the boxes that applyChecklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.Further comments
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...