diff --git a/README.md b/README.md index 10d3b79..226d74a 100644 --- a/README.md +++ b/README.md @@ -169,6 +169,10 @@ This command starts 3 containers : * [Query (C-Find) and Retrieve (C-Move) from remote modality](docs/tutorial/quickstart.md#query-c-find-and-retrieve-c-move-from-remote-modality) ### [Advanced examples](docs/tutorial/advanced.md) ### [Releases](https://github.com/gacou54/pyorthanc/releases) +### [Community guidelines](docs/contributing.md) +* [Report an issue](docs/contributing.md#report-an-issue) +* [Support](docs/contributing.md#seeking-support) +* [Contribute](docs/contributing.md#contribute) ## [Contacts](docs/contacts.md#contacts) * [Maintainers Team](docs/contacts.md#maintainers-team) * [Useful links](docs/contacts.md#useful-links) diff --git a/docs/contributing.md b/docs/contributing.md index 1f3dcf5..a1715dd 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,8 +1,18 @@ # Contribute -You can contribute to this project with the following steps: +## Report an issue +You can open an issue [here](https://github.com/gacou54/pyorthanc/issues) +explaining your issue. -1. First, fork the project on Github +## Seeking support +You can open an issue [here](https://github.com/gacou54/pyorthanc/issues) +to ask a question. + +## Contribute + +You can contribute a fix or a new feature to this project with the following steps: + +1. First, fork the project on GitHub 2. Clone the project diff --git a/docs/index.md b/docs/index.md index cce84d3..7115be4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,7 +12,7 @@ ```bash pip install pyorthanc # Basic installation -pip install pyorthanc[all] # Install all optional dependencies +pip install pyorthanc[all] # Install all optional dependencies (progr) ``` ## Basic Usage @@ -132,9 +132,11 @@ orthanc_sdk.RegisterOnStoredInstanceCallback(on_store) * [Access instance informations](tutorial/quickstart.md#access-instance-informations) ### [Advanced examples](tutorial/advanced.md) * [Transfer data from a PACS to a Orthanc server](tutorial/advanced.md#transfer-data-from-a-pacs-to-a-orthanc-server) +### [Community guidelines](contributing.md) +* [Report an issue](contributing.md#report-an-issue) +* [Support](contributing.md#seeking-support) +* [Contribute](contributing.md#contribute) ### [Releases](releases.md) -* [Lastest release : 1.12.1](releases.md#lastest-release-1121) -* [Release 1.11.5](releases.md#release-1115) ## [Contacts](contacts.md#contacts) * [Maintainers Team](contacts.md#maintainers-team) * [Useful links](contacts.md#useful-links)