From e19606ccf6aa4bdf2255c33877b1c321ea82405f Mon Sep 17 00:00:00 2001 From: Alexandre Dulaunoy Date: Thu, 26 Dec 2019 10:34:18 +0100 Subject: [PATCH] chg: [doc] How to contribute to the project --- AUTHORS | 3 +++ README.md | 15 ++++++++++----- 2 files changed, 13 insertions(+), 5 deletions(-) create mode 100644 AUTHORS diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..715bbe8 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,3 @@ +Alexandre Dulaunoy +Jean-Louis Huynen +Sebastien Tricaud diff --git a/README.md b/README.md index f4247a2..f96915a 100644 --- a/README.md +++ b/README.md @@ -37,9 +37,9 @@ More info: https://github.com/cve-search/git-vuln-finder git-vuln-finder comes with 3 default patterns which can be selected to find the potential vulnerabilities described in the commit messages such as: -- `vulnpatterns` is a generic vulnerability pattern especially targeting web application and generic security commit message. Based on an academic paper. -- `cryptopatterns` is a vulnerability pattern for cryptographic errors mentioned in commit messages. -- `cpatterns` is a set of standard vulnerability patterns see for C/C++-like languages. +- [`vulnpatterns`](https://github.com/cve-search/git-vuln-finder/blob/master/patterns/en/medium/vuln) is a generic vulnerability pattern especially targeting web application and generic security commit message. Based on an academic paper. +- [`cryptopatterns`](https://github.com/cve-search/git-vuln-finder/blob/master/patterns/en/medium/crypto) is a vulnerability pattern for cryptographic errors mentioned in commit messages. +- [`cpatterns`](https://github.com/cve-search/git-vuln-finder/blob/master/patterns/en/medium/c) is a set of standard vulnerability patterns see for C/C++-like languages. ## A sample partial output from Curl git repository @@ -153,8 +153,13 @@ Copyright (c) 2019 Alexandre Dulaunoy - https://github.com/adulau/ # Acknowledgment -- Thanks to [Jean-Louis Huynen](https://github.com/gallypette) for the discussions about the crypto vulnerability pattern -- Thanks to [Sebastien Tricaud](https://github.com/stricaud) for the discussions regarding native language and commit messages +- Thanks to [Jean-Louis Huynen](https://github.com/gallypette) for the discussions about the crypto vulnerability patterns. +- Thanks to [Sebastien Tricaud](https://github.com/stricaud) for the discussions regarding native language, commit messages and external patterns. + +# Contributing + +We welcome contributions for the software and especially additional vulnerability patterns. Every contributors will be added in the [AUTHORS file](./AUTHORS) and +collectively own this open source software. The contributors acknowledge the [Developer Certificate of Origin](https://developercertificate.org/). # References