From 8e8b5a648197ca83af50064bc9492ca855e9d705 Mon Sep 17 00:00:00 2001 From: Kurtis Rader Date: Tue, 5 Apr 2016 18:49:06 -0700 Subject: augment the guide for contributing Include information about how to deal with lint warnings and suppress `clang-format` reformatting of blocks of code. Move information only relevant to developers from the README.md to the CONTRIBUTING.md document. Closes #2901 --- README.md | 30 ++++-------------------------- 1 file changed, 4 insertions(+), 26 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index fc549ef6..648e8eb6 100644 --- a/README.md +++ b/README.md @@ -54,32 +54,6 @@ On RedHat, CentOS, or Amazon EC2: sudo yum install ncurses-devel -## Testing - -The source code for fish includes a large collection of tests. If you are making any changes to fish, running these tests is highly recommended to make sure the behaviour remains consistent. - -### Local testing - -The tests can be run on your local computer on all operating systems. - -Running the tests is only supported from the Autotools build. On OS X, you will require an installation of autoconf; we suggest using [Homebrew](http://brew.sh/) to install these tools. - - autoconf - ./configure - make test [gmake on BSD] - -### Travis CI Build and Test - -The Travis Continuous Integration services can be used to test your changes across multiple platforms. You will need to [fork the fish-shell repository on GitHub](https://help.github.com/articles/fork-a-repo/), or push a copy of the code to your GitHub account. - - 1. [Sign in to Travis CI](https://travis-ci.org/auth) with your GitHub account, accepting the GitHub access permissions confirmation. - 2. Once you're signed in, and your repositories are synchronised, go to your [profile page](https://travis-ci.org/profile) and enable the fish-shell repository. - 3. Push your changes to GitHub. - -You'll receive an email when the tests are complete telling you whether or not any tests failed. - -You'll find the configuration used to control Travis in the `.travis.yml` file. - ## Runtime Dependencies fish requires a curses implementation, such as ncurses, to run. @@ -116,6 +90,10 @@ To switch your default shell back, you can run: Substitute /bin/bash with /bin/tcsh or /bin/zsh as appropriate. +## Contributing Changes to the Code + +See the [Guide for Developers](CONTRIBUTING.md). + ## Contact Us Questions, comments, rants and raves can be posted to the official fish mailing list at or join us on our [gitter.im channel](https://gitter.im/fish-shell/fish-shell) or IRC channel [#fish at irc.oftc.net](https://webchat.oftc.net/?channels=fish). Or use the [fish tag on Stackoverflow](https://stackoverflow.com/questions/tagged/fish). -- cgit v1.2.3