From 5fd5f5d0b05f3211ff3977d5219119faae40347b Mon Sep 17 00:00:00 2001 From: sotiris Date: Mon, 8 Jun 2020 20:54:34 +0000 Subject: [PATCH] Update 'README.md' --- README.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 678c4cb..fa33533 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,28 @@ # feedback +**This page contains information about reporting issues as well as some tips and guidelines useful to experienced open source contributors.** -Repo for issues and new feature requests on main project swarmlab.io +**Finally, make sure you read our community guidelines before you start participating.** -help \ No newline at end of file +##### Reporting Security Issues + +######Reporting Issues + +1. Reporting security issues + +The Swarmlab.io maintainers take security seriously. If you discover a security issue, please bring it to their attention right away! + +> Please DO NOT file a public issue, instead send your report privately to security@swarmlab.io. + +Security reports are greatly appreciated and we will publicly thank you for it, although we keep your name confidential if you request it. +Reporting other issues + +A great way to contribute to the project is to send a detailed report when you encounter an issue. We always appreciate a well-written, thorough bug report, and will thank you for it! + +Check that our issue database doesn’t already include that problem or suggestion before submitting an issue. However, if you have ways to reproduce the issue or have additional information that may help resolving the issue, please leave a comment. + +When reporting issues, always include: as many information you can + +Also include the steps required to reproduce the problem if possible and applicable. This information will help us review and fix your issue faster. Don’t forget to remove sensitive data from your logfiles before posting (you can replace those parts with "REDACTED"). Quick contribution tips and guidelines +contributions can make a docker-compose prototype + +All developers already familiar with docker-compose and that have already set up interesting stacks that may be useful to others, are highly encouraged to add them to the repository and share them. Improvements on the current samples are also very much appreciated!