Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: rubinius/rubinius
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 1fa52d3c5679
Choose a base ref
...
head repository: rubinius/rubinius
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 7d001621f27d
Choose a head ref
  • 2 commits
  • 4 files changed
  • 1 contributor

Commits on Feb 1, 2015

  1. Updated README and added README.md.

    [ci skip]
    brixen committed Feb 1, 2015
    Copy the full SHA
    7f71916 View commit details
  2. Updated CONTRIBUTING.

    [ci skip]
    brixen committed Feb 1, 2015
    Copy the full SHA
    7d00162 View commit details
Showing with 175 additions and 134 deletions.
  1. +0 −102 CONTRIBUTING
  2. +63 −0 CONTRIBUTING.md
  3. +37 −32 README
  4. +75 −0 README.md
102 changes: 0 additions & 102 deletions CONTRIBUTING

This file was deleted.

63 changes: 63 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
## Contributing To Rubinius

We want to start off by saying thank you for using Rubinius. This project is a labor of love, and we appreciate all of the users that catch bugs, make performance improvements, and help with documentation. Every contribution is meaningful, so thank you for participating. That being said, here are a few guidelines that we ask you to follow so we can successfully address your issue.

### Submitting Issues

Please include the following:

* The Rubinius version (rbx -v)
* Your OS (uname -a) RVM/rbenv/chruby/etc version or the commit hash from git if you're building off of a clone
* Stack trace (preferably as a Gist, since they're easier to read) If you can add a failing spec, that's great!
* Please include the simplest possible reproduction you can. This last point is vital to fixing issues.

If available, please also include the contents of the following files as a Gist:

* configure.log
* config.rb

These two files contain the output of the compilation process and the various configuration options used (e.g. compiler options).

### Running Specs

MSpec provides several different scripts to run the specs under different conditions. The default behavior is to simply run all the specs. If you invoke the following command, it will run all the Ruby Array specs:

$ bin/mspec core/array

The -t option specifies which Ruby implementation to run the specs under. The default in Rubinius is to run them with Rubinius, so -tx is implied. You can easily run with another target by giving the name of an executable on your PATH or the full path to an executable. Since the specs are intended to show the behavior of MRI, if you are writing new specs you need to run them under the current stable release of MRI 2.0. For example, if you have a ruby2.0.0 executable on your PATH, you can do the following:

$ bin/mspec -t ruby2.0.0 core/array

Finally, if you are running bin/mspec in the Rubinius source directory, the location of the RubySpecs are known (spec/ruby/), so you can use the full path or the shortened version core/array above.

### Fixing A Bug

* Fork the repo, create a topic branch, and include a spec, if appropriate. Pull requests that need a spec but are submitted without one will be delayed until one is written. The spec should be in a separate commit.
* Please follow the [Coding Style Guide](http://rubini.us/doc/en/contributing/style-guide)
* **Always run the full spec suite**. `rake` will run the VM specs plus RubySpec.
* Please add a detailed commit message. Here is a [fantastic example](https://github.com/rubinius/rubinius/commit/1f9ddd1) by @ryoqun . The preference is for a (max) 50 character summary as line one, a blank line, then any number of lines, no longer than 80 characters.
* Send in that pull request!
* Follow up with us on the ticket if we haven't merged or commented in a few days. We strive to address issues in a reasonable time. If we miss yours, please remind us.
* When unsure about the changes, associated specs or other topics, please ask! We're more than eager to help.

### Writing Specs

A lot of this is already covered in [How To Write A Spec](http://rubini.us/doc/en/how-to/write-a-spec/) but the basic gist of it is as following:

* Spec descriptions (for both "describe" and "it" blocks) should be written in natural English.
* Specs should include only the bare minimum that is required to test something.
* Setup code that is re-used between examples should be placed in a before() block
* When unsure, please ask!

### Performance Patches

We love these!

* Include benchmarks before and after the change. Please include your hardware specs, namely CPU speed, # of cores, speed of hard drive (if SSD, then SSD is fine) and amount of RAM.
* **Always run the full spec suite**. `rake` will ensure you didn't accidentally break anything.

For more details on how to contribute, please see [Contributing to Rubinius](http://rubini.us/2011/10/18/contributing-to-rubinius/).

For more help, visit the [Rubinius Gitter chat room](https://gitter.im/rubinius/rubinius)

Again, thank you!
69 changes: 37 additions & 32 deletions README
Original file line number Diff line number Diff line change
@@ -1,35 +1,44 @@
1. What is Rubinius
1. The Rubinius Language Platform

Rubinius is an implementation of the Ruby programming language. Rubinius aims
to be compatible with Ruby version 2.1.
Rubinius is a modern language platform that supports a number of programming
languages.

Rubinius includes a Ruby parser, bytecode virtual machine, bytecode compiler,
generational garbage collector, and just-in-time (JIT) native machine code
compiler. Rubinius uses native OS threads with no global interpreter lock.
Rubinius also provides C-API compatibility for native C extensions.
Rubinius includes a bytecode virtual machine, generational garbage collector,
and just-in-time (JIT) native machine code compiler. Rubinius provides
concurrency support via native OS threads with no global interpreter lock.

The Ruby core library is written almost entirely in Ruby. Rubinius tools, such
as the bytecode compiler and debugger, are also written in Ruby. Rubinius
provides the same standard libraries as Matz's Ruby implementation (MRI) with
the following exceptions:
Rubinius runs on Mac OS X and many Unix/Linux operating systems. Microsoft
Windows is not yet supported.


2. The Ruby Programming Language

Many popular Ruby applications, like Rails, run on Rubinius, which aims to be
compatible with Ruby version 2.1.

Rubinius includes a Ruby parser, Ruby bytecode compiler, Ruby core library,
and C-API compatibility for native C extensions. The Ruby core library is
written almost entirely in Ruby. The Ruby bytecode compiler and other tools,
such as the debugger, are also written in Ruby. Rubinius provides the
standard Ruby libraries, with the following exceptions:

* Continuation
* Ripper
* TracePoint
* Tracer

Rubinius runs on Mac OS X and many Unix/Linux operating systems. Microsoft
Windows is not yet supported.
The following Ruby features are not supported on Rubinius:

Most popular Ruby applications, like Rails, run on Rubinius.
* Refinements
* $SAFE levels


2. License
3. License

Rubinius uses the BSD license. See LICENSE for details.


3. Installing Rubinius from Source
4. Installing Rubinius from Source

To install Rubinius, use the following steps:

@@ -46,36 +55,32 @@ information see http://rubini.us/doc/en/getting-started/requirements/
and http://rubini.us/doc/en/getting-started/building/.


4. Using RubyGems
5. Using RubyGems

Rubinius comes with RubyGems built-in. To install a gem, run the following:

rbx -S gem install <gem_name>
$ rbx -S gem install <gem_name>


6. Documentation

5. Documentation
The Rubinius documentation is available at the Rubinius website:

After installing Rubinius, run 'rbx docs' to access the built-in documentation
at any time.
http://rubini.us


6. Tickets
7. Issues & Support

Please file tickets for bugs or problems. The issue tracker is:

http://github.com/rubinius/rubinius/issues

For additional help, visit the Rubinius Gitter chat room:

7. Contributing

The Rubinius team welcomes contributions. For more information read the
CONTRIBUTING file in the root directory of Rubinius.

https://gitter.im/rubinius/rubinius

8. Features Currently Not Supported

The following features of Ruby/MRI are currently not (yet) supported by
Rubinius:
8. Contributing

* Refinements
* $SAFE levels
The Rubinius team welcomes contributions. For more information, read the
CONTRIBUTING file in the root directory of Rubinius.
75 changes: 75 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/rubinius/rubinius?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Build Status](https://travis-ci.org/rubinius/rubinius.svg?branch=master)](https://travis-ci.org/rubinius/rubinius)

## The Rubinius Language Platform

Rubinius is a modern language platform that supports a number of programming languages.

Rubinius includes a bytecode virtual machine, generational garbage collector, and just-in-time (JIT) native machine code compiler. Rubinius provides concurrency support via native OS threads with no global interpreter lock.

Rubinius runs on Mac OS X and many Unix/Linux operating systems. Microsoft Windows is not yet supported.


### The Ruby Programming Language

Many popular Ruby applications, like Rails, run on Rubinius, which aims to be
compatible with Ruby version 2.1.

Rubinius includes a Ruby parser, Ruby bytecode compiler, Ruby core library,
and C-API compatibility for native C extensions. The Ruby core library is
written almost entirely in Ruby. The Ruby bytecode compiler and other tools,
such as the debugger, are also written in Ruby. Rubinius provides the
standard Ruby libraries, with the following exceptions:

* Continuation
* Ripper
* TracePoint
* Tracer

The following Ruby features are not supported on Rubinius:

* Refinements
* $SAFE levels


### License

Rubinius uses the BSD license. See LICENSE for details.


### Installing Rubinius from Source

To install Rubinius, use the following steps:

1. Ensure that MRI 2.0+, rubygems, rake, git and LLVM are installed
1. git clone git://github.com/rubinius/rubinius.git
1. cd rubinius
1. bundle
1. ./configure --prefix=/path/to/install/dir
1. rake

When the install process finishes, follow the directions printed to the terminal to add the Rubinius executable (bin) directory to your PATH. For more information see http://rubini.us/doc/en/getting-started/requirements/ and http://rubini.us/doc/en/getting-started/building/.


### Using RubyGems

Rubinius comes with RubyGems built-in. To install a gem, run the following:

$ rbx -S gem install <gem_name>


### Documentation

The Rubinius documentation is available at the [Rubinius website](http://rubini.us).


### Issues & Support

Please [file tickets](http://github.com/rubinius/rubinius/issues) for bugs or problems.

For additional help, visit the [Rubinius Gitter chat room](https://gitter.im/rubinius/rubinius).


### Contributing

The Rubinius team welcomes contributions. For more information, read the
[CONTRIBUTING](https://github.com/rubinius/rubinius/blob/master/CONTRIBUTING) file and see the documentation [about contributing](http://rubini.us/doc/en/contributing/).