Skip to content

Commit

Permalink
Update README sync script & Contributing instructions
Browse files Browse the repository at this point in the history
- Sets a default value in README sync script
  + Default to "README.md"
  + Update `.travis.yml` to reflect this change
- Update instructions for syncing README when adding a command
  + Previously set to copy the output from an `aptible help` call
  + Instead, leverage the README usage sync script
- Updates Contributors in README
  • Loading branch information
cbortz committed Sep 21, 2017
1 parent 65b65f7 commit 52f73c8
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ rvm:

script:
- bundle exec rake
- bundle exec script/sync-readme-usage README.md
- bundle exec script/sync-readme-usage
- git diff --exit-code
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Commands:
1. Fork the project.
1. Commit your changes, with specs.
1. Ensure that your code passes specs (`rake spec`) and meets Aptible's Ruby style guide (`rake rubocop`).
1. If you add a command, update this README with the output of `aptible help | grep -v help`.
1. If you add a command, sync this README (`bundle exec script/sync-readme-usage`).
1. Create a new pull request on GitHub.

## Contributors
Expand All @@ -82,6 +82,7 @@ Commands:
* Daniel Levenson ([@dleve123](https://github.com/dleve123))
* Ryan Aipperspach ([@ryanaip](https://github.com/ryanaip))
* Chas Ballew ([@chasballew](https://github.com/chasballew))
* Chet Bortz ([@cbortz](https://github.com/cbortz))

## Copyright and License

Expand Down
2 changes: 1 addition & 1 deletion script/sync-readme-usage
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env ruby
require 'open3'

USAGE = ARGV.fetch(0)
USAGE = ARGV.fetch(0, 'README.md')

puts "Sync CLI usage in #{USAGE}"

Expand Down

0 comments on commit 52f73c8

Please sign in to comment.