From df510ba06a7f90e9806b7ff878fa3fd5448b557f Mon Sep 17 00:00:00 2001 From: mkarlstrand-splunk <49571555+mkarlstrand-splunk@users.noreply.github.com> Date: Mon, 6 Jul 2020 04:51:22 -0700 Subject: [PATCH] Update CONTRIBUTING.md (#550) Add guidance on handling of samples --- docs/CONTRIBUTING.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index e210a11..d9c3c73 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -4,6 +4,15 @@ When contributing to this repository, please first discuss the change you wish to make via a GitHub issue or Slack message with the owners of this repository. +##Data Safety + +Splunk Connect for Syslog is a community built and maintained product. Anyone with internet access can get a Splunk GitHub account and participate. Just as with any publicly available repository, care must be taken to never share private data via Issues, Pull Requests or any other mechanisms. Any data that is shared in the Splunk Connect for Syslog GitHub repository is available to the entire Community without limits. No members of the Community or their employers (including Splunk) can be held responsible for any damages resulting from the sharing of private data via the Splunk GitHub. + +Any data samples shared in the Splunk GitHub repository must be free of private data. +* Working locally, identify potentially sensitive field values in data samples (Public IP address, Public URL, Hostname, Etc.) +* Replace all potentially sensitive field values with synthetic values +* Manually review data samples to re-confirm they are free of private data before sharing in the Splunk GitHub + ##Setup Development Environment For a basic development environment docker and a bash shell is all you need. For a more complete IDE experience see our wiki (Setup PyCharm)[https://github.com/splunk/splunk-connect-for-syslog/wiki/SC4S-Development-Setup-Using-PyCharm] @@ -79,4 +88,4 @@ We could always use improvements to our documentation! Anyone can contribute to * More complementary documentation. Have you perhaps found something unclear? * More examples or generic templates that others can use. * Blog posts, articles and such – they’re all very appreciated. -* You can also edit documentation files directly in the GitHub web interface, without creating a local copy. This can be convenient for small typos or grammar fixes. \ No newline at end of file +* You can also edit documentation files directly in the GitHub web interface, without creating a local copy. This can be convenient for small typos or grammar fixes.