From 4b0c4bdf4ec3b8ddc7803eff3e08b7a792a9003d Mon Sep 17 00:00:00 2001 From: ROUVREAU Vincent Date: Thu, 13 Feb 2020 16:50:56 +0100 Subject: [skip ci] Add .github folder --- .github/CONTRIBUTING.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 .github/CONTRIBUTING.md (limited to '.github/CONTRIBUTING.md') diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..e69de29b -- cgit v1.2.3 From e98d18182076ef5f66361a6ef404e55ff13567e4 Mon Sep 17 00:00:00 2001 From: ROUVREAU Vincent Date: Thu, 13 Feb 2020 17:18:14 +0100 Subject: [skip ci] Add some contributing content --- .github/CONTRIBUTING.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) (limited to '.github/CONTRIBUTING.md') diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e69de29b..eacf32f8 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# Contributing to GUDHI + +First of all, thank you for the time you may take to contribute to GUDHI ! + +# In case you have a question + +Please, check our [contact web page](https://gudhi.inria.fr/contact/). + +# In case you found an issue + +Please, first check [opened issues on GUDHI](https://github.com/GUDHI/gudhi-devel/issues). + +If the problem you are facing is not referenced, do not hesitate to open a [new issue](https://github.com/GUDHI/gudhi-devel/issues/new). + +This place is also a good place if you have some enhancement you want to propose for the GUDHI library. +There is a label **enhancement** in the [new issue](https://github.com/GUDHI/gudhi-devel/issues/new) page. + +# In case you want to contribute to GUDHI + +## You are not familiar with GitHub ? + +Please take some time to read our [how to use GitHub to contribute to GUDHI](/home/vincent/workspace/gudhi/gudhi-devel/for_dev/how_to_use_github_to_contribute_to_gudhi.md). + +## Something you want to improve in the documentation + +For C++ documentation, you can find it in the directories: +* *src/common/doc* for the main page and installation instructions +* *src/NAME_OF_THE_MODULE/doc* for the main page of a module +* *src/NAME_OF_THE_MODULE/include/gudhi* for the documentation generated from the code. +We use Doxygen to generate the code and you will be able to verify the result in CircleCI Doxygen target in the artifacts. + +For Python documentation, you can find it in the directories: +* *src/python/doc* for the main page, installation instructionsand for the main pages of the modules +* *src/python/gudhi/NAME_OF_THE_MODULE.pyx* for the documentation generated from the code. +We use Sphinx to generate the code and you will be able to verify the result in CircleCI Sphinx target in the artifacts. + +## Something you want to improve in the code + +Please first take some time to read our [code conventions](code_conventions.md) + -- cgit v1.2.3 From 8dc47a277c50744812a6e65e8e817fed479b301d Mon Sep 17 00:00:00 2001 From: ROUVREAU Vincent Date: Thu, 13 Feb 2020 17:25:55 +0100 Subject: [skip ci] contributing --- .github/CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to '.github/CONTRIBUTING.md') diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index eacf32f8..29fe0aaa 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -12,7 +12,7 @@ Please, first check [opened issues on GUDHI](https://github.com/GUDHI/gudhi-deve If the problem you are facing is not referenced, do not hesitate to open a [new issue](https://github.com/GUDHI/gudhi-devel/issues/new). -This place is also a good place if you have some enhancement you want to propose for the GUDHI library. +This place is also a good place if you have some enhancement you want to propose. There is a label **enhancement** in the [new issue](https://github.com/GUDHI/gudhi-devel/issues/new) page. # In case you want to contribute to GUDHI @@ -38,3 +38,6 @@ We use Sphinx to generate the code and you will be able to verify the result in Please first take some time to read our [code conventions](code_conventions.md) +As a convention, we set a Pull Request as a **Draft Pull Request** when we work on something we want the other contributors to see. + +We click on **Ready for review** to ask for a peer review of the contribution. \ No newline at end of file -- cgit v1.2.3 From f9e77bbeabf307dbc4e6f1521c1567fe9bf1123f Mon Sep 17 00:00:00 2001 From: Vincent Rouvreau <10407034+VincentRouvreau@users.noreply.github.com> Date: Wed, 19 Feb 2020 08:49:15 +0100 Subject: Doc review: precaution on contribution [skip ci] --- .github/CONTRIBUTING.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to '.github/CONTRIBUTING.md') diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 29fe0aaa..13d6cad7 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -36,8 +36,13 @@ We use Sphinx to generate the code and you will be able to verify the result in ## Something you want to improve in the code -Please first take some time to read our [code conventions](code_conventions.md) +We don't ask for any paperwork but we expect you don't submit anything you are not allowed to: +* check that your work contract and your employer allow you to contribute to this open source project. +* insure you do not violate someone's intellectual property. +* ... + +Please, take some time to read our [code conventions](code_conventions.md) As a convention, we set a Pull Request as a **Draft Pull Request** when we work on something we want the other contributors to see. -We click on **Ready for review** to ask for a peer review of the contribution. \ No newline at end of file +We click on **Ready for review** to ask for a peer review of the contribution. -- cgit v1.2.3 From c1ce28b8e8021097825a893564aed97757f2ac8e Mon Sep 17 00:00:00 2001 From: Vincent Rouvreau <10407034+VincentRouvreau@users.noreply.github.com> Date: Thu, 5 Mar 2020 14:27:43 +0100 Subject: Fix bad link --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to '.github/CONTRIBUTING.md') diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 13d6cad7..a18ff8bd 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -19,7 +19,7 @@ There is a label **enhancement** in the [new issue](https://github.com/GUDHI/gud ## You are not familiar with GitHub ? -Please take some time to read our [how to use GitHub to contribute to GUDHI](/home/vincent/workspace/gudhi/gudhi-devel/for_dev/how_to_use_github_to_contribute_to_gudhi.md). +Please take some time to read our [how to use GitHub to contribute to GUDHI](how_to_use_github_to_contribute_to_gudhi.md). ## Something you want to improve in the documentation -- cgit v1.2.3