Skip to content

Commit

Permalink
More info on issue reporting and contribution
Browse files Browse the repository at this point in the history
  • Loading branch information
gacou54 committed Jan 16, 2025
1 parent f812a27 commit a610c8d
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 5 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
14 changes: 12 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
8 changes: 5 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down

0 comments on commit a610c8d

Please sign in to comment.