From 737da73dd6eca73a8b59ac73fc2b3a598c36058d Mon Sep 17 00:00:00 2001 From: David Adam Date: Thu, 24 Aug 2017 22:54:53 +0800 Subject: [PATCH] CONTRIBUTING.md: add note about dependencies (cherry picked from commit 6cff72b226bfd37fb03d01faf444f411a65b0f21) --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2dfb0cc13..d39bf9da6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,9 @@ See the bottom of this document for help on installing the linting and style ref Fish source should limit the C++ features it uses to those available in C++11. It should not use exceptions. +Before introducing a new dependency, please make it optional with graceful failure if possible. Add +any new dependencies to the README.md under the *Running* and/or *Building* sections. + ## Versioning The fish version is constructed by the *build_tools/git_version_gen.sh* script. For developers the version is the branch name plus the output of `git describe --always --dirty`. Normally the main part of the version will be the closest annotated tag. Which itself is usually the most recent release number (e.g., `2.6.0`).