Warning: This application is currently in its initial iteration and may not yet function as shown here in the readme.
A private pastebin for individuals and teams.
- Linux or OS X (Windows is not supported)
- Ruby 2.2+
- PostgreSQL 9.3+
TODO: Put installation instructions here.
TODO: Put getting started instructions here.
TODO: Put configuration instructions here.
Full online help for Vurse is available in each installation at
See the YARD documentation for the latest RDoc documentation.
Generate local documentation with YARD (output to the
$ bin/rake yard
Development and testing
- Linux or Mac OS X (development on Windows is not supported)
- Runtime requirements as detailed above
The easiest way to set up a local development environment for Vurse is via:
If you ever need to reset your development environment, run:
$ RESET=1 bin/setup
Run all tests:
$ bin/rake spec
Run all unit tests:
$ bin/rake spec:unit
Run all acceptance tests:
$ bin/rake spec:features
$ bin/rake lint
$ bin/rake lint:ruby
Inline documentation for Ruby code is also analyzed by inch in order to find areas to improve on. The inline documentation linter can be run by itself via:
$ bin/rake lint:docs
$ bin/rake lint:stylesheets
If you have discovered an issue with Vurse of a sensitive nature that could compromise the security of Vurse users, please report it securely by sending a GPG-encrypted message instead of filing an issue on GitHub. Please use the following key and send your report to email@example.com.
The fingerprint of the key should be:
6EED 2359 968F 7734 06A4 AB56 D90E 487A 60F1 0579
If you use Keybase, you can also send me a signed, encrypted message with:
$ keybase encrypt tabolario -s -m 'Your message'
Contributing and reporting issues
See CONTRIBUTING.md for full information on how to contribute or report issues to Vurse.
Vurse follows Semver 2.0.0 for release versioning. The version number components X.Y.Z have the following meanings:
- X for Major releases that may contain backwards-incompatible changes.
- Y for Minor releases that may contain features, bug fixes, and backwards-compatible changes.
- Z for Patch releases that only contain bug fixes and trivial changes.
Pre-release versions like
X.Y.Z.beta.1 will be made before Major, and Minor versions. Pre-release versions
are well-tested, but not as thoroughly as the versions that they precede.
Whenever a new version is made, it will be tagged as a release on GitHub Releases. Entries in CHANGELOG.md will be made incrementally up to the release. An announcement will also be made on Twitter, RubyFlow, /r/ruby and /r/rails.
When a new Major version is made, a corresponding branch will be created named
X-0-0 for further Minor and Patch releases on
© 2015 Tony Burns
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.