-
-
Notifications
You must be signed in to change notification settings - Fork 161
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
Refactor documentation #456
Conversation
features/README.md
Outdated
### Your First Tests with "aruba" | ||
|
||
1. Clone the "Getting Started" application and install its dependencies | ||
2. Install the required depencies |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo depencies
=> dependencies
features/README.md
Outdated
|
||
1. Create a file named "spec/spec_helper.rb" with the following content. If the | ||
file already exists add the line to the file. | ||
1. Add the following line to the "spec/spec_helper.rb"-file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove the hyphenation in the last word. -file
=> file
features/README.md
Outdated
|
||
1. Add a file named "test/test_helper.rb" with: | ||
1. Add the following line to the "test/test_helper.rb"-file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is an extra -
to remove here, as well.
features/README.md
Outdated
|
||
1. Go to your project's directory | ||
|
||
2. Make sure, it's under version control and all changes are committed to your |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make sure, it's
=> Make sure it's
Cool change! I read the text and made tiny notes where I found things that can change. |
@olleolleolle Fixed. Did you use the review for your comments? |
@maxmeyer No, I thought I was only adding "loose commentary" so I made Single Comments of each. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Several issues fixed.
Using the Getting Started conventional wording helps the reader who is scanning the text quickly.
Good change!
|
||
1. Add a file named "test/test_helper.rb" with: | ||
1. Add the following line to the "test/test_helper.rb" file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think test/test_helper.rb
exists in the sample repo, does it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I forgot to push that commit. Shall be now online.
I'll try out the instructions as per this PR again tonight. |
Summary
This fixes based on this comment by @mvz. Additionally it does some minor refactorings to the README
Details
aruba
with existing projects to the end to make the README more accessible for first timersMotivation and Context
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: