diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 210020714..d3df2afe8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,23 +43,13 @@ If you can, please limit yourself to only one category. This way, all tools get treated fairly and the list is easier to read. -# How to mark a tool as unmaintained/deprecated - -Sometimes it happens that a tool becomes unmaintained and there's nothing wrong -with that. -After all, a tool can still be very valuable to the community - even without -frequent updates. -However, since it is one of the goals of this project to allow people to make an -informed decision on what is the best tool for the job, we are marking -unmaintained or deprecated tools with a :warning: (`:warning:`) sign. -This sign indicates that the community does not recommend to use this tool for -new projects anymore. - -[Here](https://github.com/mre/awesome-static-analysis/issues/223) is a nice -discussion about why we think this is necessary. If you find a tool, which is -unmaintained, please create a pull request which adds the `:warning:` sign and -provide an objective explanation as to why you think the tool should be marked. -Every deprecation will be handled on a case-by-case basis. +# Deprecating tools +Sometimes it happens that you come across a tool, which might not be a good fit for the list anymore. For example, it has not received any updates in a very long time. +In such a case, please remember that the tool can still be very valuable to the community - it might just not be a good fit for your specific use-case. + +If you still find that a tool should be avoided, please create a pull request which adds an `:information_source:` sign and provide an objective explanation as to why you think the tool should be marked. If possible, please also mention the project maintainers there, so we can find a solution together. + +Please keep in mind that behind every project there are human beings which put a lot of effort into building and maintaining a project, so be nice and constructive. **Thanks for helping out!** :tada: diff --git a/README.md b/README.md index 7eb7fbacf..51c4c1457 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,8 @@ This is a collection of static analysis tools and code quality checkers. Pull requests are very welcome! * :copyright: stands for proprietary software. All other tools are Open Source. -* :warning: indicates that the community does not recommend to use this tool for - new projects anymore as it is outdated or no longer maintained. +* :information_source: indicates that there was a discussion about the current state of the + tool. You can get further information from the link in the description. Also check out the sister project, [awesome-dynamic-analysis](https://github.com/mre/awesome-dynamic-analysis). @@ -256,8 +256,8 @@ Also check out the sister project, [awesome-dynamic-analysis](https://github.com * [eslint](https://github.com/eslint/eslint) - A fully pluggable tool for identifying and reporting on patterns in JavaScript * [Esprima](https://github.com/jquery/esprima) - ECMAScript parsing infrastructure for multipurpose analysis * [flow](https://flow.org/) - A static type checker for JavaScript. -* [jshint](https://github.com/jshint/jshint) :warning: - detect errors and potential problems in JavaScript code and enforce your team's coding conventions -* [JSLint](https://github.com/douglascrockford/JSLint) :warning: - The JavaScript Code Quality Tool +* [jshint](https://github.com/jshint/jshint) :information_source: - detect errors and potential problems in JavaScript code and enforce your team's coding conventions ([Discussion](https://github.com/mre/awesome-static-analysis/issues/223)) +* [JSLint](https://github.com/douglascrockford/JSLint) :information_source: - The JavaScript Code Quality Tool ([Discussion](https://github.com/mre/awesome-static-analysis/issues/223)) * [JSPrime](https://github.com/dpnishant/jsprime) - static security analysis tool * [NodeJSScan](https://github.com/ajinabraham/NodeJsScan) - NodeJsScan is a static security code scanner for Node.js applications. * [plato](https://github.com/es-analysis/plato) - Visualize JavaScript source complexity diff --git a/ci/Cargo.lock b/ci/Cargo.lock index 28f27000b..ed0de7825 100644 --- a/ci/Cargo.lock +++ b/ci/Cargo.lock @@ -39,7 +39,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" [[package]] name = "ci" -version = "0.2.0" +version = "0.3.0" dependencies = [ "failure 0.1.5 (registry+https://github.com/rust-lang/crates.io-index)", "lazy_static 1.2.0 (registry+https://github.com/rust-lang/crates.io-index)", diff --git a/ci/src/lib.rs b/ci/src/lib.rs index b0790611d..dd7626fd1 100644 --- a/ci/src/lib.rs +++ b/ci/src/lib.rs @@ -7,7 +7,7 @@ use regex::Regex; use std::cmp::Ordering; lazy_static! { - static ref TOOL_REGEX: Regex = Regex::new(r"\*\s\[(?P.*)\]\((?Phttp[s]?://.*)\)\s(:warning:\s)?(:copyright:\s)?\-\s(?P.*)").unwrap(); + static ref TOOL_REGEX: Regex = Regex::new(r"\*\s\[(?P.*)\]\((?Phttp[s]?://.*)\)\s(:information_source:\s)?(:copyright:\s)?\-\s(?P.*)").unwrap(); static ref SUBSECTION_HEADLINE_REGEX: Regex = Regex::new(r"[A-Za-z\s]*").unwrap(); }