Adding a Hacking document.

This commit is contained in:
Austin Ziegler 2010-03-24 23:16:58 -04:00 committed by Kaspar Schiess
parent 1589556dd2
commit 97fbae9849
3 changed files with 31 additions and 7 deletions

16
Hacking.rdoc Normal file
View file

@ -0,0 +1,16 @@
= Hacking Net::LDAP
We welcome your contributions to Net::LDAP. To increase the chances of your
patches being accepted, we recommend that you follow the guidelines below:
1. Your code should be formatted like the rest of Net::LDAP. We use a text
wrap of 76 - 78 characters, especially for documentation contents.
Operators should have spaces around them, method definitions should have
parentheses around arguments. Keep the indentation as flat as possible.
2. Your changes should be well-documented and described.
3. You must provide rspec tests for any new or changed features. Rspec has
been chosen as the way forward for tests.
4. You should provide LDIF data for importing into LDAP servers so that the
changes can be tested <em>in situ</em> with more than one real LDAP
server.
5. You should have tested your changes against a real LDAP server.

View file

@ -1,4 +1,5 @@
COPYING
Hacking.rdoc
History.txt
LICENSE
Manifest.txt
@ -7,14 +8,14 @@ Rakefile
lib/net-ldap.rb
lib/net/ber.rb
lib/net/ber/ber_parser.rb
lib/net/ber/core_ext.rb
lib/net/ber/core_ext/array.rb
lib/net/ber/core_ext/bignum.rb
lib/net/ber/core_ext/false_class.rb
lib/net/ber/core_ext/fixnum.rb
lib/net/ber/core_ext/string.rb
lib/net/ber/core_ext/true_class.rb
lib/net/ldap.rb
lib/net/ldap/core_ext/all.rb
lib/net/ldap/core_ext/array.rb
lib/net/ldap/core_ext/bignum.rb
lib/net/ldap/core_ext/false_class.rb
lib/net/ldap/core_ext/fixnum.rb
lib/net/ldap/core_ext/string.rb
lib/net/ldap/core_ext/true_class.rb
lib/net/ldap/dataset.rb
lib/net/ldap/entry.rb
lib/net/ldap/filter.rb
@ -26,6 +27,10 @@ spec/integration/ssl_ber_spec.rb
spec/spec.opts
spec/spec_helper.rb
spec/unit/ber/ber_spec.rb
spec/unit/ber/core_ext/string_spec.rb
spec/unit/ldap/entry_spec.rb
spec/unit/ldap/filter_spec.rb
spec/unit/ldap_spec.rb
test/common.rb
test/test_ber.rb
test/test_entry.rb

View file

@ -1,4 +1,5 @@
require "rubygems"
require 'hanna/rdoctask'
require 'hoe'
$LOAD_PATH.unshift('lib')
@ -33,6 +34,8 @@ Hoe.spec PKG_NAME do
self.changes = paragraphs_of(self.history_file, 0..1).join("\n\n")
self.description = paragraphs_of(self.readme_file, 2..2).join("\n\n")
extra_rdoc_files << "Hacking.rdoc"
extra_dev_deps << [ "archive-tar-minitar", "~>0.5.1" ]
extra_dev_deps << [ "hanna", "~>0.1.2" ]
extra_dev_deps << [ "hoe-git", "~>1" ]