From 4b2f6832fe7d3c26aa4f6ca44c314143d933c00f Mon Sep 17 00:00:00 2001 From: Jeremy Long Date: Sun, 2 Apr 2017 12:58:17 -0400 Subject: [PATCH] added contributing guidelines --- .github/contributing.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 .github/contributing.md diff --git a/.github/contributing.md b/.github/contributing.md new file mode 100644 index 000000000..8cc056c2f --- /dev/null +++ b/.github/contributing.md @@ -0,0 +1,33 @@ +# Contributing to OWASP dependency-check + +## Reporting Bugs + +- Ensure you're running the latest version of dependency-check. +- Ensure the bug has not [already been reported](https://github.com/jeremylong/DependencyCheck/issues). +- If you're unable to find an open issue addressing the problem, please [submit a new issue](https://github.com/jeremylong/DependencyCheck/issues/new). + - Please fill out the appropriate section of the bug report template provided. Please delete any sections not needed in the template. + +## Reporting Vulnerabilities + +- If you believe you have found a vulnerability in dependency-check itself (not that dependency-check found a vulnerability); please email jeremy.long@owasp.org. + +## Asking Questions + +- Your question may be answered by taking a look at the [documentataion](https://jeremylong.github.io/DependencyCheck/). +- If you still have a question consider: + - posting to the [Google Group](https://groups.google.com/forum/#!forum/dependency-check) + - opening a [new issue](https://github.com/jeremylong/DependencyCheck/issues/new) + +## Enhancement Requests + +- Suggest changes by [submitting a new issue](https://github.com/jeremylong/DependencyCheck/issues/new) and begin coding. + +## Contributing Code + +- If you have written a new feature or have fixed a bug please open a new pull request with the patch. +- Ensure the PR description clearly describes the problem and solution. Include any related issue number(s) if applicable. +- Please ensure the PR passes the automated checks performed (travis-ci, codacy, etc.) + +## Thank you for your contributions + +OWASP dependency-check team \ No newline at end of file