wreise
diff --git a/‎AUTHORS
Lines changed: 0 additions & 10 deletions b/‎AUTHORS
Lines changed: 0 additions & 10 deletions
diff --git a/‎CODE_AUTHORS.rst
Lines changed: 6 additions & 0 deletions b/‎CODE_AUTHORS.rst
Lines changed: 6 additions & 0 deletions
diff --git a/‎CODE_OF_CONDUCT.rst
Lines changed: 3 additions & 3 deletions b/‎CODE_OF_CONDUCT.rst
Lines changed: 3 additions & 3 deletions
diff --git a/‎CONTRIBUTING.rst
Lines changed: 103 additions & 0 deletions b/‎CONTRIBUTING.rst
Lines changed: 103 additions & 0 deletions
diff --git a/‎DEED_OF_CONTRIBUTIONS.rst renamed to ‎DEED_OF_CONTRIBUTION.rst
Lines changed: 9 additions & 11 deletions b/‎DEED_OF_CONTRIBUTIONS.rst renamed to ‎DEED_OF_CONTRIBUTION.rst
Lines changed: 9 additions & 11 deletions
diff --git a/‎GOVERNANCE.rst
Lines changed: 14 additions & 44 deletions b/‎GOVERNANCE.rst
Lines changed: 14 additions & 44 deletions
@@ -0,0 +1,6 @@
+# The following is the list of the code authors of the giotto-learn python
+# package. Where component authors are known, add them here. 
+
+L2F SA
+EPFL - Ecole Polytechnique Fédérale de Lausanne
+REDS Institute of the Haut Ecole d'Ingénierie et Gestion du canton Vaud
@@ -45,11 +45,11 @@ Examples of representing a project or community include using an official projec
 Enforcement
 -----------
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at <[email protected]>. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances, Sanctions may include written warnings, expulsions from the project, project sponsored spaces, or project forums, or any other sanction which is deemed appropriate. [The project team] is obligated to maintain confidentiality with regard to the reporter of an incident. If the act is ongoing (such as someone engaging in harassment) or involves a threat to anyone's safety (e.g. threats of violence), the the project team may issue sanctions without notice. Further details of specific enforcement policies may be posted separately.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at <[email protected]>. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances, Sanctions may include written warnings, expulsions from the project, project sponsored spaces, or project forums, or any other sanction which is deemed appropriate. [The project team] is obligated to maintain confidentiality with regard to the reporter of an incident. If the act is ongoing (such as someone engaging in harassment) or involves a threat to anyone's safety (e.g. threats of violence), the the project team may issue sanctions without notice. Further details of specific enforcement policies may be posted separately.
 
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by the project leader.
 
 Attribution
 -----------
 
-This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>, and includes some aspects of the Giotto Code of Conduct, available at <https://github.com/giotto-learn/giotto-learn/blob/master/CODE_OF_CONDUCT.rst>
+This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>, and includes some aspects of the TensorFlow Code of Conduct, available at <https://github.com/tensorflow/tensorflow/blob/master/CODE_OF_CONDUCT.md>
@@ -0,0 +1,103 @@
+Contributing guidelines
+=======================
+
+Pull Request Checklist
+----------------------
+
+Before sending your pull requests, make sure you followed this list.
+  - Read [contributing guidelines](GOVERNANCE.rst).
+  - Read [Code of Conduct](CODE_OF_CONDUCT.rst).
+  - Ensure you have signed the [Contributor License Agreement (CLA)](DEED_OF_CONTRIBUTIONS.rst).
+  - Check if the changes are consistent with the guidelines.
+  - Changes are consistent with the Coding Style.
+  - Run Unit Tests.
+
+How to become a contributor and submit your own code
+----------------------------------------------------
+
+Contributor License Agreements
+------------------------------
+
+In order to become a contributor of Giotto, the first step is to fill out the
+[Contributor License Agreement (CLA)](DEED_OF_CONTRIBUTIONS.rst).
+Ican sign the document and send it to <[email protected]>. Once we receive
+it, we'll be able to accept your pull requests.
+**NOTE**: Only original source code from you and other people that have signed
+the CLA can be accepted into the main repository.
+
+Contributing code
+-----------------
+
+If you have improvements to Giotto, do not hesitate to send us pull requests!
+Please follow the Github [how to](https://help.github.com/articles/using-pull-requests/).
+The Giotto Team will review your pull requests. Once the pull requests are approved and pass continuous integration checks, the
+Giotto team will work on getting your pull request submitted to our GitHub
+repository. Eventually, your pull request will be merged automatically on GitHub.
+If you want to contribute, start working through the Giotto codebase,
+navigate to the [Github "issues" tab](https://github.com/giotto-learn/giotto-learn/issues)
+and start looking through interesting issues. These are issues that we believe
+are particularly well suited for outside contributions, often because we
+probably won't get to them right now. If you decide to start on an issue, leave
+a comment so that other people know that you're working on it. If you want to
+help out, but not alone, use the issue comment thread to coordinate.
+
+Contribution guidelines and standards
+-------------------------------------
+
+Before sending you pull request for review, make sure your changes are
+consistent with the guidelines and follow the coding style below.
+
+General guidelines and philosophy for contribution
+--------------------------------------------------
+
+* Include unit tests when you contribute new features, as they help to
+  a) prove that your code works correctly, and
+  b) guard against future breaking changes to lower the maintenance cost.
+* Bug fixes also generally require unit tests, because the presence of bugs
+  usually indicates insufficient test coverage.
+* Keep API compatibility in mind when you change code in core Giotto.
+* Clearly define your exceptions using the utils functions and test the exceptions.
+* When you contribute a new feature to Giotto, the maintenance burden is   
+  (by default) transferred to the Giotto team. This means that the benefit   
+  of the contribution must be compared against the cost of maintaining the   
+  feature.
+
+C++ coding style
+----------------
+
+Changes to Giotto C/C++ code should conform to [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html).
+Use `clang-tidy` to check your C/C++ changes. To install `clang-tidy` on
+ubuntu:16.04, do:
+
+.. code-block:: python
+
+    bashapt-get install -y clang-tidy
+
+You can check a C/C++ file by doing:
+
+.. code-block:: python
+
+    bashclang-format <my_cc_file> --style=google > /tmp/my_cc_file.ccdiff <my_cc_file> /tmp/my_cc_file.cc
+
+Python coding style
+-------------------
+
+Changes to Giotto Python code should conform to PEP8 directives.
+Use `flake8` to check your Python changes. To install `flake8` just do
+
+.. code-block:: python
+
+    pip install flake8
+
+You can use `flake8` on your python code via the following instructions:
+.. code-block:: python
+
+    flake8 name_of_your_script.py
+
+Running unit tests
+------------------
+
+There are two ways to run Giotto unit tests.
+  1.  Using tools and libraries installed directly on your system. The election
+  tool is pytest.
+  2.  Using [Azure](azure-pipelines.yml) and Giotto's CI scripts.  
@@ -1,7 +1,7 @@
-L2F – Contributor Assignment Agreement
-======================================
+L2F – Contributor License Agreement
+===================================
 
-In order to clarify the intellectual property license granted with Contributions from any person or entity, L2F SA, Bâtiment D EPFL Innovation Park, 1015 Lausanne, Switzerland (**L2F**) must have a Contributor Assignment Agreement on file that has been signed by each Contributor, indicating agreement to the terms below. This agreement (the **Agreement**) is for Your protection as a contributor as well as the protection of L2F.
+In order to clarify the intellectual property license granted with Contributions from any person or entity, L2F SA, Bâtiment D EPFL Innovation Park, 1015 Lausanne, Switzerland (**L2F**) must have a Contributor License Agreement on file that has been signed by each Contributor, indicating agreement to the terms below. This agreement (the **Agreement**) is for Your protection as a contributor as well as the protection of L2F.
 
 You accept and agree to the following terms and conditions for Your present and future Contributions submitted to L2F. Except for the rights granted herein to L2F, and (at L2F’s discretion) recipients of software made available by L2F, You reserve all right, title, and interest in and to Your Contributions.
 
@@ -14,13 +14,11 @@ You accept and agree to the following terms and conditions for Your present and
 
 **Your Essential Patent Claims** shall mean all patent claims owned or controlled by You, whether already acquired or hereafter acquired, that would be infringed by some manner of making, using, or selling Your Contribution, but do not include claims that would be infringed only as a consequence of further modification of Your Contribution. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this Agreement.
 
-2.	Copyrights 
+2.	Copyrights
 --------------
 
-(a)	At the time Your Contribution is Submitted, You assign to L2F all right, title, and interest worldwide in all rights of authorship and other copyrights covering Your Contribution.
-(b)	To the extent that any of the rights in Section 2.1 cannot be assigned by You to L2F, You grant to L2F a perpetual, worldwide, non-exclusive, no-charge, royalty-free, transferable, irrevocable license under such non-assigned rights, with rights to sublicense through multiple tiers of sublicensees, to practice such non-assigned rights, including, but not limited to, the right to reproduce, modify, prepare derivative works of, publicly display, publicly perform, propagate, sublicense, and distribute Your Contribution.
-(c)	To the extent that any of the rights in Section 2.1 can neither be assigned nor licensed by You to L2F, You irrevocably waive and agree never to assert such rights against L2F, any of L2F’s successors in interest, or any of L2F’s licensees, either direct or indirect. 
-(d)	Upon such transfer of rights to L2F, to the maximum extent possible, L2F immediately grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, transferable, irrevocable license under such rights covering Your Contribution, with rights to sublicense through multiple tiers of sublicensees, to reproduce, modify, prepare derivative works of, publicly display, publicly perform, propagate, sublicense, and distribute Your Contribution. The intention of the parties hereto is that this license will be as broad as possible and to provide You with rights as similar as possible to the owner of the rights that You transferred. This license back is limited to Your Contribution and does not provide any further rights to the Work.
+Subject to the terms and conditions of this Agreement, You hereby grant to L2F and to recipients of software distributed by L2F (at L2F’s discretion) a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, modify, prepare derivative works of, publicly display, publicly perform, propagate, sublicense, and distribute Your Contributions and such derivative works.
+To the extent that any of such rights cannot be licensed by You to L2F, You irrevocably waive and agree never to assert such rights against L2F, any of L2F’s successors in interest, or any of L2F’s licensees, either direct or indirect.
 
 3.	Patents
 -----------
@@ -40,18 +38,18 @@ You agree to notify L2F of any facts or circumstances of which You become aware
 
 You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON- INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
 
-6.	Submissions on behalf of others 
+6.	Submissions on behalf of others
 -----------------------------------
 
 Should You wish to submit work that is not Your original creation, You may submit it to L2F separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which You are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]".
 
 7.	L2F’s Rights
 ----------------
 
-(a)	No Duty to Use. You acknowledge that L2F is not obligated to use Your Contribution as part of a Work and may decide to include any Contribution it considers appropriate. 
+(a)	No Duty to Use. You acknowledge that L2F is not obligated to use Your Contribution as part of a Work and may decide to include any Contribution it considers appropriate.
 (b)	Outbound License. If L2F includes Your Contribution in a Work, it may license Your Contribution under any license, including copyleft, permissive, commercial, or proprietary licenses.
 
-8.	Miscellaneous 
+8.	Miscellaneous
 -----------------
 
 (a)	*Severability*. If any provision of this Agreement is held to be invalid or unenforceable for any reason, the parties hereto shall replace it by a substitute provision that achieves to the fullest extent possible the same legal and economic purposes as those of the invalid or unenforceable provision. In any event, the remainder of this Agreement shall remain in full force and effect between the parties,
 
@@ -1,50 +1,20 @@
-# Contributing guidelines
-## Pull Request Checklist
-Before sending your pull requests, make sure you followed this list.
-  - Read [contributing guidelines](GOVERNANCE.md).
-  - Read [Code of Conduct](CODE_OF_CONDUCT.rst).
-  - Ensure you have signed the [Contributor License Agreement (CLA)](DEED_OF_CONTRIBUTIONS.rst).
-  - Check if my changes are consistent with the guidelines.
-  - Changes are consistent with the Coding Style.
-  - Run Unit Tests.
-## How to become a contributor and submit your own code
-### Contributor License Agreements
-We'd love to accept your patches! Before we can take them, we have to jump a couple of legal hurdles.
-Please fill out either the individual or corporate Contributor License Agreement (CLA).
-    * If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an [individual CLA](DEED_OF_CONTRIBUTIONS.rst).
-    * If you work for a company that wants to allow you to contribute your work, then you'll need to sign a corporate CLA (please write at <[email protected]>).
-Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests.
-***NOTE***: Only original source code from you and other people that have signed the CLA can be accepted into the main repository.
-### Contributing code
-If you have improvements to Giotto, send us your pull requests! For thosejust getting started, Github has a[how to](https://help.github.com/articles/using-pull-requests/).
-Giotto team members will be assigned to review your pull requests. Once thepull requests are approved and pass continuous integration checks, a Giotto team member will apply `ready to pull` label to your change. This means we areworking on getting your pull request submitted to our internal repository. Afterthe change has been submitted internally, your pull request will be mergedautomatically on GitHub.
-If you want to contribute, start working through the Giotto codebase,navigate to the [Github "issues" tab](https://github.com/giotto-learn/giotto-learn/issues) and startlooking through interesting issues. These are issues that we believe are particularly well suited for outsidecontributions, often because we probably won't get to them right now. If youdecide to start on an issue, leave a comment so that other people know thatyou're working on it. If you want to help out, but not alone, use the issuecomment thread to coordinate.
-### Contribution guidelines and standards
-Before sending your pull request for review, make sure your changes are consistent with the guidelines and follow the Giotto coding style.¯
-#### General guidelines and philosophy for contribution
-   * Include unit tests when you contribute new features, as they help to a)    prove that your code works correctly, and b) guard against future breaking    changes to lower the maintenance cost.*   Bug fixes also generally require unit tests, because the presence of bugs    usually indicates insufficient test coverage.*   Keep API compatibility in mind when you change code in core Giotto. Reviewers of    your pull request will comment on any API compatibility issues.*   When you contribute a new feature to Giotto, the maintenance burden is    (by default) transferred to the Giotto team. This means that the benefit    of the contribution must be compared against the cost of maintaining the    feature.
-   * Full new features (e.g., a new op implementing a cutting-edge algorithm)    typically will live in    [giotto-learn/addons](https://github.com/giotto-learn/addons) to get some    airtime before a decision is made regarding whether they are to be migrated to the core.
-#### C++ coding style
-Changes to Giotto C/C++ code should conform to [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html).
-Use `clang-tidy` to check your C/C++ changes. To install `clang-tidy` on ubuntu:16.04, do:
+This file describe the governance of the Giotto project.
 
-```bashapt-get install -y clang-tidy```
+Project owner:
+--------------
 
-You can check a C/C++ file by doing:
+- L2F SA
 
-```bashclang-format <my_cc_file> --style=google > /tmp/my_cc_file.ccdiff <my_cc_file> /tmp/my_cc_file.cc```
+Authors:
+--------
 
-#### Python coding style
-Changes to Giotto Python code should conform to [Google Python Style Guide](https://github.com/google/styleguide/blob/gh-pages/pyguide.md)
-Use `pylint` to check your Python changes. To install `pylint` and retrieve Giotto's custom style definition:
+- Please refer to the [authors](CODE_AUTHORS) file
 
-```bash pip install pylintwget -O /tmp/pylintrc https://raw.githubusercontent.com/giotto-learn/giotto-learn/master/giotto/tools/ci_build/pylintrc```
+Giotto Project Team:
+--------------------
 
-To check a file with `pylint`:
-
-```bashpylint --rcfile=/tmp/pylintrc myfile.py```
-
-#### Running unit tests
-There are two ways to run Giotto unit tests.
-   1.  Using tools and libraries installed directly on your system. The election tool is pytest.
-   2.  Using [Azure](azure-pipelines.yml) and TensorFlow's CI scripts.  
+- Guillaume Tauzin [email protected] (Maintainer & Main Developer)
+- Umberto Lupo [email protected] (Maintainer & Developer)
+- Matteo Caorsi [email protected] (Project leader)
+- Philippe Nguyen [email protected] (Developer)
+- Alessio Ghiraldello [email protected] (Developer)