Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions CONTRIBUTING.md
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
Copy link
Member

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in b5fad16

- 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can link to the test/support directory with relative links.

Copy link
Member Author

Choose a reason for hiding this comment

The 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update this to ruby-ldap/ruby-net-ldap

Copy link
Member Author

Choose a reason for hiding this comment

The 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/