From bd180874332b72a40ba529662714444f359a1734 Mon Sep 17 00:00:00 2001 From: Daniel Garijo Date: Thu, 12 Jan 2023 11:09:39 +0100 Subject: [PATCH] contribution guidelines --- CONTRIBUTING.md | 2 ++ README.md | 5 ++++- 2 files changed, 6 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d9871f2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,2 @@ +## Contribution guidelines +Contributions to address any of the current issues are welcome. In order to push your contribution, just **push your pull request to the development branch (dev)**. The master branch has only the code associated to the latest release. diff --git a/README.md b/README.md index 28b310e..d78af49 100644 --- a/README.md +++ b/README.md @@ -180,7 +180,7 @@ For clarity, we have added a `help` command to explain each input parameter: ``` inspect4py --help -``` + Usage: inspect4py [OPTIONS] Options: @@ -225,6 +225,9 @@ Options: For additional documentation and examples, please have a look at our [online documentation](https://inspect4py.readthedocs.io/en/latest/) +## Contribution guidelines +Contributions to address any of the current issues are welcome. In order to push your contribution, just **push your pull request to the development branch (`dev`)**. The master branch has only the code associated to the latest release. + ## Acknowledgements We would like to thank Laura Camacho, designer of the logo