-
Notifications
You must be signed in to change notification settings - Fork 254
Add contributing guide #147
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # Contribution guide | ||
|
|
||
| Thank you for using net-ldap. If you'd like to help, keep these guidelines in | ||
| mind. | ||
|
|
||
| ## Submitting a New Issue | ||
|
|
||
| If you find a bug, or would like to propose an idea, file a [new issue][issues]. | ||
| Include as many details as possible: | ||
|
|
||
| - Ruby and Rubygem version | ||
| - LDAP server version | ||
| - Queries, connection information, any other input | ||
| - output or error messages | ||
|
|
||
| ## Sending a Pull Request | ||
|
|
||
| [Pull requests][pr] are always welcome! | ||
|
|
||
| Check out [the project's issues list][issues] for ideas on what could be improved. | ||
|
|
||
| Before sending, please add tests and ensure the test suite passes. | ||
|
|
||
| To run the full suite: | ||
|
|
||
| `bundle exec rake` | ||
|
|
||
| To run a specific test file: | ||
|
|
||
| `bundle exec ruby test/test_ldap.rb` | ||
|
|
||
| To run a specific test: | ||
|
|
||
| `bundle exec ruby test/test_ldap.rb -n test_instrument_bind` | ||
|
|
||
| Pull requests will trigger automatic continuous integration builds on | ||
| [TravisCI][travis]. To run integration tests locally, see the `test/support` | ||
| folder. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We can link to the
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Didn't link this because it's an empty folder and doesn't reference well in GitHub UI. |
||
|
|
||
| ## Styleguide | ||
|
|
||
| ```ruby | ||
| # 1.9+ style hashes | ||
| {key: "value"} | ||
|
|
||
| # Multi-line arguments with `\` | ||
| MyClass.new \ | ||
| foo: 'bar', | ||
| baz: 'garply' | ||
| ``` | ||
|
|
||
| [issues]: https://github.com/jch/html-pipeline/issues | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Update this to
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed in 78c3c42 |
||
| [pr]: https://help.github.com/articles/using-pull-requests | ||
| [travis]: https://travis-ci.org/ruby-ldap/ruby-net-ldap/ | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you mean this gem's version or the version of Rubygems they're using? Might want to clarify the language here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in b5fad16