Datasets:
gadams
/
ruby

Dataset card Data Studio Files
xet
 Community
text
stringlengths
0
444
* https://www.patreon.com/bbatsov[Patreon]
* https://www.paypal.me/bbatsov[PayPal]
=== How to Contribute?
It's easy, just follow the contribution guidelines below:
* https://help.github.com/articles/fork-a-repo[Fork] https://github.com/rubocop/ruby-style-guide[rubocop/ruby-style-guide] on GitHub
* Make your feature addition or bug fix in a feature branch.
* Include a https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[good description] of your changes
* Push your feature branch to GitHub
* Send a https://help.github.com/articles/using-pull-requests[Pull Request]
== Colophon
This guide is written in https://asciidoc.org/[AsciiDoc] and is published as HTML using https://asciidoctor.org/[AsciiDoctor].
The HTML version of the guide is hosted on GitHub Pages.
Originally the guide was written in Markdown, but was converted to AsciiDoc in 2019.
== License
image:https://i.creativecommons.org/l/by/3.0/88x31.png[Creative Commons License] This work is licensed under a https://creativecommons.org/licenses/by/3.0/deed.en_US[Creative Commons Attribution 3.0 Unported License]
== Spread the Word
A community-driven style guide is of little use to a community that doesn't know about its existence.
Tweet about the guide, share it with your friends and colleagues.
Every comment, suggestion or opinion we get makes the guide just a little bit better.
And we want to have the best possible guide, don't we?
----
.circleci/config.yml
version: 2
jobs:
docs-build:
docker:
- image: ruby:2.6
steps:
- checkout
- run:
name: Install AsciiDoctor & Rouge
command: |
gem install asciidoctor
gem install rouge -v 3.3.0
- run:
name: Build Site
command: asciidoctor -a toc="left" -a toclevels=2 README.adoc -o _build/html/index.html
- persist_to_workspace:
root: _build
paths: html
docs-deploy:
docker:
- image: node:8.10.0
steps:
- checkout
- attach_workspace:
at: _build
- run:
name: Disable jekyll builds
command: touch _build/html/.nojekyll
- run:
name: Install and configure dependencies
command: |
npm install -g --silent gh-pages@2.0.1
git config user.email "ci-build@rubystyle.guide"
git config user.name "ci-build"
- add_ssh_keys:
fingerprints:
- "ea:f9:10:fa:c9:1c:7d:cd:f9:21:37:bf:a8:ee:b9:c9"
- run:
name: Deploy docs to gh-pages branch
command: gh-pages -add --dotfiles --message "[skip ci] Update site" --dist _build/html
workflows:
version: 2
build:
jobs:
- docs-build
- docs-deploy:
requires:
- docs-build
filters:
branches:
only: master
--END--