Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

39 lines (30 loc) · 1.97 KB
Raw

Contributing to Natalie

Everyone is welcome to contribute to Natalie!

We are building a kind of Ruby implementation, following as closely as possible to what Matz's Ruby Interpreter (MRI) does. Where this is not possible, we do the best we can.

When contributing to Natalie, make sure that the changes you make are in line with the project direction. If you are not sure about this, open an issue first so we can discuss it.

Code Formatting

  • Use clang-format to automatically format C++ files. You can run rake format.
  • Use rubocop to keep Ruby style and usage consistent.

Tests

  • We prefer specs be brought over from ruby/spec so we are sure to match MRI's behavior.
  • As we are working to get a spec passing, we inevitably will need to disable certain parts of the spec that aren't yet passing. We prefer to use the NATFIXME helper to do this, which is documented here. (We usually don't comment out failing tests.)
  • If existing Ruby specs are not enough to fully define a feature, we try to make adjustments to ruby/spec and upstream the changes with a pull request to that project.
  • As a last resort, or during certain difficult bootstrapping processes, we sometimes add custom tests to the tests/ directory, especially if such tests are specific to a Natalie feature or quirk.

Code submission policy

  • Split your changes into separate, atomic commits (i.e. A commit per feature or fix, where the tests all pass).
  • Wrap your commit messages at 72 characters (even the subject).
  • Write the commit message subject line in the imperative mood, starting with a capital letter ("Fix Array#first", not "fixed Array#first" and not just "Array#first").
  • Write your commit messages in proper English, with care and punctuation.
  • Squash your commits when making revisions after a PR review.
  • Check the spelling of your code, comments and commit messages.