From d1a07dbc67dde06de2db95fe859ec977fb6d07d4 Mon Sep 17 00:00:00 2001 From: Emeka Mosanya Date: Mon, 23 Sep 2019 19:05:44 +0200 Subject: [PATCH] Updates contributing blurb --- README.md | 22 +++++++++++++++++++--- docs/_sidebar.md | 2 +- docs/contributing.md | 16 ++++++++++++++++ docs/index.html | 6 ++++++ 4 files changed, 42 insertions(+), 4 deletions(-) create mode 100644 docs/contributing.md diff --git a/README.md b/README.md index 39f3ed09c..1f40a5392 100644 --- a/README.md +++ b/README.md @@ -58,10 +58,26 @@ Proxeus platform. *TODO: link to the github pages documentation site when ready* The user manual is available here: [User Manual](https://docs.google.com/document/d/1SP0ZimG7uemfZ2cF2JkY5enUZnBJLDyfcJGZnyWOejQ) -## 3 Misc +## Contributing -### 3.1 XES-Payment +As an open-source project, we welcome any kind of community involvement, whether that is by contributing code, reporting issues or +engaging in insightful discussions. Especially, we are looking forward to receiving contributions for custom workflow nodes. + +See the [coding style](coding_style.md) section for instructions on the coding style we use. + +Please use our support@proxeus.com email to open improvement and bug tickets. + +### Security Issues + +If you find a vulnerability that may affect live or testnet deployments please send your report privately to +security@proxeus.com. Please DO NOT file a public issue. + +## Misc + +### XES-Payment For more info check the [XES-Payment Readme](docs/xes-payment.md). -### 3.2 Smart contracts & Solidity +### Smart contracts & Solidity For more info check the [Smart contracts & Solidity Readme](https://github.com/ProxeusApp/proxeus-contract). + + diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 461f9c34d..dd2355e1c 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -38,7 +38,7 @@ - [Custom Workflow Nodes](custom_workflow_nodes.md) -- Contributing +- [Contributing](contributing.md) - [Coding Style](coding_style.md) diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 000000000..b43867b8f --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,16 @@ +## Contributing + +As an open-source project, we welcome any kind of community involvement, whether that is by contributing code, reporting issues or +engaging in insightful discussions. Especially, we are looking forward to receiving contributions for custom workflow nodes. + +See the [coding style](coding_style.md) section for instructions on the coding style we use. + +Please use our support@proxeus.com email to open improvement and bug tickets. + + +### Security Issues + +If you find a vulnerability that may affect live or testnet deployments please send your report privately to +security@proxeus.com. Please DO NOT file a public issue. + + diff --git a/docs/index.html b/docs/index.html index 041950a10..e7fc9cba8 100644 --- a/docs/index.html +++ b/docs/index.html @@ -7,6 +7,12 @@ +