Sha256: b11ab482da6dd990cb22f0d049a294d7ae62d74de7a151c07763af8da8fc9c1b

Contents?: true

Size: 1.24 KB

Versions: 160

Compression:

Stored size: 1.24 KB

Contents

Contributing
============

Code Conventions
----------------

Code style should fall in line with the style guide outlined by
[Github](https://github.com/styleguide/ruby)

Testing
-------

Bug fixes and new features should always have the appropriate specs, and the
specs should follow the following guidelines:

- Prefer `let` and `let!` over the use of instance variables and `subject`.
- Prefer `expect(...).to eq(...) syntax over `...should eq(...)`.
- Use shared examples to reduce duplication.
- Use `describe "#method"` for instance method specs.
- Use `describe ".method"` for class method specs.
- Use `context` blocks to set up conditions.
- Always provide descriptive specifications via `it`.

Specs can be automatically run with Guard, via `bundle exec guard`

Before commiting, run `rake` to ensure all specs pass with both pure Ruby and
the native extensions.

Git Etiquette
-------------

Please follow the commit message guidelines as outlined
[in this blog post](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).

If the commit fixes a bug, please add the JIRA number on the last line:

```
[ close RUBY-492 ]
```

Please ensure that only one feature/bug fix is in each pull request, and
that it is squashed into a single commit.

Version data entries

160 entries across 157 versions & 4 rubygems

Version Path
bson-5.0.2 CONTRIBUTING.md
bson-5.0.2-java CONTRIBUTING.md
bson-5.0.1 CONTRIBUTING.md
bson-5.0.1-java CONTRIBUTING.md
bson-5.0.0-java CONTRIBUTING.md
bson-5.0.0 CONTRIBUTING.md
mongo_kerberos-2.1.1 CONTRIBUTING.md
bson-4.15.0-java CONTRIBUTING.md
bson-4.15.0 CONTRIBUTING.md
bson-4.14.1-java CONTRIBUTING.md
bson-4.14.1 CONTRIBUTING.md
bson-4.14.0-java CONTRIBUTING.md
bson-4.14.0 CONTRIBUTING.md
bson-4.13.0-java CONTRIBUTING.md
bson-4.13.0 CONTRIBUTING.md
tdiary-5.1.6 vendor/bundle/ruby/2.7.0/gems/bson-4.12.0/CONTRIBUTING.md
bson-4.12.1-java CONTRIBUTING.md
bson-4.12.1 CONTRIBUTING.md
bson-4.12.0-java CONTRIBUTING.md
bson-4.12.0 CONTRIBUTING.md