summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
Commit message (Collapse)AuthorAge
* Update location of Makefile.am in CONTRIBUTING.mdGravatar Rebecca Meritz2017-10-25
|
* GovernanceGravatar Mike Burns2017-03-10
| | | | | | | | Document the contract between maintainer, committer, contributor, and meta-contributors. This documents how it currently works, not how we wish it to work. Start there so that we can consciously improve.
* Running an individual test requires the pathGravatar Mike Burns2015-11-15
| | | | | Now that the Makefile is non-recursive, running an individual test requires specifying the full path.
* Do not depend on readlink(1) or -qGravatar Jarkko Kniivilä2015-11-01
| | | | | | | | | | | | | | | | | Solaris 10 lacks readlink(1). Additionally, its different grep(1) and diff(1) do not take a `-q` flag. Use a Perl one-liner instead of readlink(1) which is missing on Solaris 10. Also because /usr/bin/grep and diff(1) don't understand the `-q` option, make them go quiet by redirecting stdout to `/dev/null` instead. The Perl dependency only exists in the test suite, so it does not incur a runtime penalty for end users. This is to work around the fact that readlink(1) is missing on Solaris. The tradeoff is: on Solaris, installing third-party software (readlink) is a pain, whereas on e.g. FreeBSD installing third-party software (Perl) is simple and common.
* Link to thoughtbot's contributor code of conductGravatar Mike Burns2015-04-08
|
* Improve setup documentationGravatar Martin Frost2015-01-07
| | | | | | | Improve the `CONTRIBUTING.md` documentation about what dependencies exist, how to install them, and how to get started in general. Remind developers about the `configure` script, because without it no `Makefile` will exist.
* Expand on instructions for contributors to get startedGravatar Melissa Xie2014-11-24
| | | | | | | | These changes: * add the steps needed to get set up * update the docs regarding mandatory tests * clarify release instructions * fix documentation formatting
* Fix broken mailmap documentation linkGravatar Melissa Xie2014-11-18
| | | | | It was not the full path to the docs, but let's also just refer to the version on master.
* An integration test suiteGravatar patrick brisbin2014-04-08
| | | | | | | | | | | | | | | | | | | | | | | This test suite uses cram to run integration tests through `/bin/sh`. The tests are all high-level acceptance tests; they should work regardless of the implemention code. To run them, you must first install cram: sudo pip install cram Then the `check` target will run them: make check Failure output should be printed clearly to stdout, but in general: full test output is in `test/test-suite.log` and output specific to a test named `foo.t` is in `foo.t.log`. Tests are now encouraged in `CONTRIBUTING.md` as part of the normal pull request process. This is a TAP-enabled test suite.
* Generate the list of contributors from gitGravatar Mike Burns2014-03-20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | Instead of requiring contributors to update rcm(7), pull the list of contributors from the git log instead. The `rcm.7` file has been moved to `rcm.7.mustache`. The `autogen.sh` command will write `rcm.7` using autocontrib, a quick script included in this commit. This commit adds a `.mailmap` file, used by git-shortlog(1) to produce correct and useful names and email addresses. An initial `.mailmap` has been added to correct some existing email addresses and duplications. `.mailmap` is documented in [Documentation/mailmap.txt][mailmap] for git. This adds a maintainer dependency on Ruby and the mustache gem. The autocontrib program is spiked out in Ruby due to my familarity with the language, but the choice of templating language (mustache) allows flexibility for switching languages later. This is a dependency requirement only for people who run `autogen.sh` -- maintainers. This adds a maintainer dependency on git. Again, this is only for maintainers, and many (all?) of them need git to get rcm's source anyway. Thanks to Patrick Brisbin and George Brocklehurst for the review. [mailmap]: https://github.com/git/git/blob/6a907786af835ac15962be53f1492f23e044f479/Documentation/mailmap.txt
* Add a list of contributors to rcm(7)Gravatar Mike Burns2014-02-28
This list is an alphabetical listing of everyone who has authored at least one commit, plus their email address. When the author is a coworker I have changed this to use their thoughtbot email address. This also updates the `AUTHORS` section to mention thoughtbot. The `NEWS.md.in` file has been changed to reflect that 1.2.0 is released. A `CONTRIBUTING.md` file has been added to explain what is required to send a good contribution.