From 06ee20e929656d41c301f61fd447105c3840e410 Mon Sep 17 00:00:00 2001
From: Austin Ziegler <austin@zieglers.ca>
Date: Tue, 6 May 2014 00:08:02 -0400
Subject: diff-lcs 1.3

- Updated testing and gem infrastructure.
- Cleaning up documentation.
- Modernizing specs.
- Silence Ruby 2.4 Fixnum deprecation warnings. Fixes #36, #38.
- Ensure test dependencies are loaded. Fixes #33, #34 so that specs can be run
  independently.
- Fix issue #1 with incorrect intuition of patch direction. Tentative fix, but
  the failure cases pass now.
---
 Contributing.md | 83 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 83 insertions(+)
 create mode 100644 Contributing.md

(limited to 'Contributing.md')

diff --git a/Contributing.md b/Contributing.md
new file mode 100644
index 0000000..3eb81ee
--- /dev/null
+++ b/Contributing.md
@@ -0,0 +1,83 @@
+## Contributing
+
+I value any contribution to Diff::LCS you can provide: a bug report, a feature
+request, or code contributions. Code contributions to Diff::LCS are especially
+<del>welcome</del>encouraged. Because Diff::LCS is a complex codebase, there
+are a few guidelines:
+
+*   Code changes *will not* be accepted without tests. The test suite is
+    written with [RSpec][].
+*   Match my coding style.
+*   Use a thoughtfully-named topic branch that contains your change. Rebase
+    your commits into logical chunks as necessary.
+*   Use [quality commit messages][].
+*   Do not change the version number; when your patch is accepted and a release
+    is made, the version will be updated at that point.
+*   Submit a GitHub pull request with your changes.
+*   New or changed behaviours require appropriate documentation.
+
+### Test Dependencies
+
+Diff::LCS uses Ryan Davis’s [Hoe][] to manage the release process, and it adds
+a number of rake tasks. You will mostly be interested in:
+
+    $ rake
+
+which runs the tests the same way that:
+
+    $ rake spec
+    $ rake travis
+
+will do.
+
+To assist with the installation of the development dependencies, I have
+provided a Gemfile pointing to the (generated) `diff-lcs.gemspec` file. This
+will permit you to do:
+
+    $ bundle install
+
+to get the development dependencies. If you aleady have `hoe` installed, you
+can accomplish the same thing with:
+
+    $ rake newb
+
+This task will install any missing dependencies, run the tests/specs, and
+generate the RDoc.
+
+You can run tests with code coverage analysis by running:
+
+    $ rake spec:coverage
+
+### Workflow
+
+Here's the most direct way to get your work merged into the project:
+
+*   Fork the project.
+*   Clone down your fork (`git clone git://github.com/<username>/diff-lcs.git`).
+*   Create a topic branch to contain your change (`git checkout -b
+    my_awesome_feature`).
+*   Hack away, add tests. Not necessarily in that order.
+*   Make sure everything still passes by running `rake`.
+*   If necessary, rebase your commits into logical chunks, without errors.
+*   Push the branch up (`git push origin my_awesome_feature`).
+*   Create a pull request against halostatue/diff-lcs and describe what your
+    change does and the why you think it should be merged.
+
+### Contributors
+
+*   Austin Ziegler created Diff::LCS.
+
+Thanks to everyone else who has contributed to Diff::LCS:
+
+*   Kenichi Kamiya
+*   Michael Granger
+*   Vít Ondruch
+*   Jon Rowe
+*   Koichi Ito
+*   Josef Strzibny
+*   Josh Bronson
+*   Mark Friedgan
+
+[Rspec]: http://rspec.info/documentation/
+[quality commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[Hoe]: https://github.com/seattlerb/hoe
-- 
cgit v1.2.1