From bd72492c34f9ff31c2875663b39ef1a7ba8b02c0 Mon Sep 17 00:00:00 2001 From: Sebastien Dinot Date: Wed, 1 May 2019 01:30:01 +0200 Subject: [PATCH 01/16] README file renamed and rewritten, using Markdown --- README.md | 84 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.txt | 31 -------------------- 2 files changed, 84 insertions(+), 31 deletions(-) create mode 100644 README.md delete mode 100644 README.txt diff --git a/README.md b/README.md new file mode 100644 index 000000000..fd2f6b500 --- /dev/null +++ b/README.md @@ -0,0 +1,84 @@ +![Orekit logo](https://www.orekit.org/img/orekit-logo.png) + +# Orekit + +> An accurate and efficient core layer for space flight dynamics applications + +[Orekit](https://www.orekit.org) is a low level space dynamics library written +in Java. Orekit is designed to be easily used in very different contexts, from +quick studies up to critical operations. As a library, Orekit provides basic +elements (orbits, dates, attitude, frames, ...) and various algorithms to +handle them (conversions, propagations, pointing, ...). + +## Documentation + +Project overview, architecture and development, detailed features list, +tutorials, Javadoc and a lot of other information is available on the +[Maven site](https://www.orekit.org/site-orekit-development/). + +## Getting help + +The main communication channel is our [forum](https://forum.orekit.org/). You +can report bugs and suggest new features in our +[issues tracking system](https://gitlab.orekit.org/orekit/orekit/issues). + +## Contributing + +If you are interested in participating in the development effort, subscribe to +the [forum](https://forum.orekit.org/) and step up to discuss it. The larger +the community is, the better Orekit will be. The main rule is that everything +intended to be included in Orekit core must be distributed under the Apache +License Version 2.0 (you will be asked to sign a contributor license +agreement). + +More information is available in our +[development guidelines](https://www.orekit.org/site-orekit-development/guidelines.html). + +## Building + +Detailed information on how to build Orekit from source either using Maven or +Eclipse is provided in [building.md](src/site/markdown/building.md) file. + +[Official Orekit artifacts](https://mvnrepository.com/artifact/org.orekit/orekit) +are available on Maven public repository and on the +(Orekit web site](http://orekit.org/download.html). + +* The [src/main/java](src/main/java) directory contains the library sources. +* The [src/main/resources](src/main/resources) directory contains the library + data. +* The [src/test/java](src/test/java) directory contains the tests sources. +* The [src/test/resources](src/test/resources) directory contains the tests + data. +* The [src/tutorials/java](src/tutorials/java) directory contains sources for + example use of the library. +* The [src/tutorials/resources](src/tutorials/resources) directory contains + example data. +* The [src/design](src/design) directory contains pieces for a UML model of + the library. + +## Dependencies + +Orekit relies on the following free software, all released under business +friendly free licenses. + +### Compile-time/run-time dependency + +* [Hipparchus](https://hipparchus.org/) from the Hipparchus project released + under the Apache Software License, version 2 + +### Test-time dependency + +* [JUnit 4](http://www.junit.org/) from Erich Gamma and Kent Beck released + under the Eclipse Public License, version 1.0 + +* [Mockito](https://site.mockito.org/) from Szczepan Faber and others, + released under MIT license. + +More detailed information is available in the +[Maven site](https://www.orekit.org/site-orekit-development/dependencies.html) + +## License + +Orekit is licensed by [CS Systèmes d'Information](https://www.c-s.fr/) under +the [Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html). +A copy of this license is provided in the [LICENSE.txt](LICENSE.txt) file. diff --git a/README.txt b/README.txt deleted file mode 100644 index 8a9fe692b..000000000 --- a/README.txt +++ /dev/null @@ -1,31 +0,0 @@ -Orekit (ORbit Extrapolation KIT) is a free java library -providing basic space dynamics objects and services. - -It is licensed by CS Systèmes d'Information under the -Apache License Version 2.0. A copy of this license is -provided in the LICENSE.txt file. - -The BUILDING.txt file explains how the library can be built from sources. - -The src/main/java directory contains the library sources. -The src/main/resources directory contains the library data. -The src/test/java directory contains the tests sources. -The src/test/resources directory contains the tests data. -The src/tutorials/java directory contains sources for example use of the library. -The src/tutorials/resources directory contains example data. -The src/design directory contains pieces for a UML model of the library. - -Orekit relies on the following free software, all released under -business friendly free licenses. - -compile-time/run-time dependency: - - - Hipparchus from the Hipparchus project - https://hipparchus.org/ - released under the Apache Software License, version 2 - -test-time dependency: - - - JUnit 4 from Erich Gamma and Kent Beck - http://www.junit.org/ - released under the Common Public License Version 1.0 -- GitLab From 530d32a6ad48fbf85d455f828041a2b7c3a966bb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Dinot?= Date: Wed, 1 May 2019 01:34:00 +0200 Subject: [PATCH 02/16] Various minor formatting corrections. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fd2f6b500..c7b596928 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ Eclipse is provided in [building.md](src/site/markdown/building.md) file. [Official Orekit artifacts](https://mvnrepository.com/artifact/org.orekit/orekit) are available on Maven public repository and on the -(Orekit web site](http://orekit.org/download.html). +[Orekit web site](http://orekit.org/download.html). * The [src/main/java](src/main/java) directory contains the library sources. * The [src/main/resources](src/main/resources) directory contains the library @@ -75,7 +75,7 @@ friendly free licenses. released under MIT license. More detailed information is available in the -[Maven site](https://www.orekit.org/site-orekit-development/dependencies.html) +[Maven site](https://www.orekit.org/site-orekit-development/dependencies.html). ## License -- GitLab From f8d2a4a290181ff534db9a266ea2a169ad6dfa63 Mon Sep 17 00:00:00 2001 From: Sebastien Dinot Date: Wed, 1 May 2019 21:31:31 +0200 Subject: [PATCH 03/16] Updated list of canonical names and email addresses of contributors --- .mailmap | 70 +++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 49 insertions(+), 21 deletions(-) diff --git a/.mailmap b/.mailmap index 8c1fd8e75..81b7c45f1 100644 --- a/.mailmap +++ b/.mailmap @@ -1,21 +1,49 @@ -Bruno Revelin Bruno Revelin -Evan Ward Evan Ward -Evan Ward Evan Ward -Fabien Maussion Fabien Maussion -Francesco Rocca Francesco Rocca <> -Luc Maisonobe Luc Maisonobe -Luc Maisonobe Luc Maisonobe -Luc Maisonobe Luc Maisonobe -Luc Maisonobe maisonobe -Pascal Parraud Pascal Parraud -Romain di Costanzo rdicosta -Steven Steven -Thierry Ceolin Thierry Ceolin -Thierry Ceolin thierry ceolin -Thierry Ceolin thierry ceolin -Thomas Neidhart Thomas Neidhart -Véronique Pommier-Maurussane Véronique Pommier-Maurussane -Nicolas Bernard Nicola Bernard -Romain di Costanzo Romain Di Costanzo -Joris Olympio jolympio -Piotr Listkiewicz liscju +Albert Alcarraz García Albert Alcarraz García +Andrea Antolino Andrea Antolino +Andrea Antolino Andrea Antolino +Bruno Revelin Bruno Revelin +Bryan Cazabonne Bryan +Bryan Cazabonne Bryan Cazabonne +Daniel De Sousa Daniel De Sousa +Evan Ward Evan Ward +Evan Ward Evan Ward +Fabien Maussion Fabien Maussion +Francesco Rocca Francesco Rocca <> +Greg Carbott Greg Carbott +Guilhem Bonnefille Guilhem Bonnefille +Guylaine Prat Guylaine Prat +Hank Grabowski Hank Grabowski +Joris Olympio Joris Olympio +Joris Olympio jolympio +Luc Maisonobe Luc Maisonobe +Luc Maisonobe Luc Maisonobe +Luc Maisonobe Luc Maisonobe +Luc Maisonobe maisonobe +Lucian Barbulescu Lucian Barbulescu +Madalin Mamuleanu Madalin Mamuleanu +MaksimP MaksimP +Maxime Journot Maxime Journot +Maxime Journot Maxime Journot +Nicolas Bernard Nicola Bernard +Nicolas Bernard Nicolas Bernard +Pascal Parraud Pascal Parraud +Pavel Bludov Pavel Bludov +Piotr Listkiewicz Piotr Listkiewicz +Piotr Listkiewicz liscju +rnveach rnveach +Robert Painsi Robert Painsi +Romain di Costanzo Romain Di Costanzo +Romain di Costanzo rdicosta +Roman Ivanov Roman Ivanov +Sébastien Dinot Sebastien Dinot +Sébastien Dinot Sebastien Dinot +Sébastien Dinot Sébastien Dinot +Sébastien Dinot Sébastien Dinot +Steven Steven +Steven Ports Steven Ports +Thierry Ceolin Thierry Ceolin +Thierry Ceolin thierry ceolin +Thierry Ceolin thierry ceolin +Thomas Neidhart Thomas Neidhart +Véronique Pommier-Maurussane Véronique Pommier-Maurussane +Yannick Jeandroz Yannick Jeandroz -- GitLab From 9a3a62a8faaab0b64b70ec00f598fc5d14c46bf2 Mon Sep 17 00:00:00 2001 From: Sebastien Dinot Date: Wed, 1 May 2019 21:42:05 +0200 Subject: [PATCH 04/16] Revert "Updated list of canonical names and email addresses of contributors" This reverts commit f8d2a4a290181ff534db9a266ea2a169ad6dfa63. --- .mailmap | 70 +++++++++++++++++--------------------------------------- 1 file changed, 21 insertions(+), 49 deletions(-) diff --git a/.mailmap b/.mailmap index 81b7c45f1..8c1fd8e75 100644 --- a/.mailmap +++ b/.mailmap @@ -1,49 +1,21 @@ -Albert Alcarraz García Albert Alcarraz García -Andrea Antolino Andrea Antolino -Andrea Antolino Andrea Antolino -Bruno Revelin Bruno Revelin -Bryan Cazabonne Bryan -Bryan Cazabonne Bryan Cazabonne -Daniel De Sousa Daniel De Sousa -Evan Ward Evan Ward -Evan Ward Evan Ward -Fabien Maussion Fabien Maussion -Francesco Rocca Francesco Rocca <> -Greg Carbott Greg Carbott -Guilhem Bonnefille Guilhem Bonnefille -Guylaine Prat Guylaine Prat -Hank Grabowski Hank Grabowski -Joris Olympio Joris Olympio -Joris Olympio jolympio -Luc Maisonobe Luc Maisonobe -Luc Maisonobe Luc Maisonobe -Luc Maisonobe Luc Maisonobe -Luc Maisonobe maisonobe -Lucian Barbulescu Lucian Barbulescu -Madalin Mamuleanu Madalin Mamuleanu -MaksimP MaksimP -Maxime Journot Maxime Journot -Maxime Journot Maxime Journot -Nicolas Bernard Nicola Bernard -Nicolas Bernard Nicolas Bernard -Pascal Parraud Pascal Parraud -Pavel Bludov Pavel Bludov -Piotr Listkiewicz Piotr Listkiewicz -Piotr Listkiewicz liscju -rnveach rnveach -Robert Painsi Robert Painsi -Romain di Costanzo Romain Di Costanzo -Romain di Costanzo rdicosta -Roman Ivanov Roman Ivanov -Sébastien Dinot Sebastien Dinot -Sébastien Dinot Sebastien Dinot -Sébastien Dinot Sébastien Dinot -Sébastien Dinot Sébastien Dinot -Steven Steven -Steven Ports Steven Ports -Thierry Ceolin Thierry Ceolin -Thierry Ceolin thierry ceolin -Thierry Ceolin thierry ceolin -Thomas Neidhart Thomas Neidhart -Véronique Pommier-Maurussane Véronique Pommier-Maurussane -Yannick Jeandroz Yannick Jeandroz +Bruno Revelin Bruno Revelin +Evan Ward Evan Ward +Evan Ward Evan Ward +Fabien Maussion Fabien Maussion +Francesco Rocca Francesco Rocca <> +Luc Maisonobe Luc Maisonobe +Luc Maisonobe Luc Maisonobe +Luc Maisonobe Luc Maisonobe +Luc Maisonobe maisonobe +Pascal Parraud Pascal Parraud +Romain di Costanzo rdicosta +Steven Steven +Thierry Ceolin Thierry Ceolin +Thierry Ceolin thierry ceolin +Thierry Ceolin thierry ceolin +Thomas Neidhart Thomas Neidhart +Véronique Pommier-Maurussane Véronique Pommier-Maurussane +Nicolas Bernard Nicola Bernard +Romain di Costanzo Romain Di Costanzo +Joris Olympio jolympio +Piotr Listkiewicz liscju -- GitLab From c891be426861aad17cbd8972004faf56cb1eeb3c Mon Sep 17 00:00:00 2001 From: Sebastien Dinot Date: Wed, 1 May 2019 21:46:10 +0200 Subject: [PATCH 05/16] Corrected spelling mistake --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c7b596928..6a9a01df1 100644 --- a/README.md +++ b/README.md @@ -61,12 +61,12 @@ are available on Maven public repository and on the Orekit relies on the following free software, all released under business friendly free licenses. -### Compile-time/run-time dependency +### Compile-time/run-time dependencies * [Hipparchus](https://hipparchus.org/) from the Hipparchus project released under the Apache Software License, version 2 -### Test-time dependency +### Test-time dependencies * [JUnit 4](http://www.junit.org/) from Erich Gamma and Kent Beck released under the Eclipse Public License, version 1.0 -- GitLab From 851c1b39c01c754192b9bf11c308ee711e137476 Mon Sep 17 00:00:00 2001 From: Sebastien Dinot Date: Thu, 2 May 2019 17:13:33 +0200 Subject: [PATCH 06/16] Taking into account README file renaming in the assembly file --- src/main/assembly/source-distribution-assembly.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/assembly/source-distribution-assembly.xml b/src/main/assembly/source-distribution-assembly.xml index 8642941a6..87f961088 100644 --- a/src/main/assembly/source-distribution-assembly.xml +++ b/src/main/assembly/source-distribution-assembly.xml @@ -6,7 +6,7 @@ - README.txt + README.md LICENSE.txt NOTICE.txt BUILDING.txt @@ -23,4 +23,4 @@ true - \ No newline at end of file + -- GitLab From b95f50f83fb5090bfc7ae1c20707d47adea1102b Mon Sep 17 00:00:00 2001 From: Sebastien Dinot Date: Thu, 2 May 2019 18:00:25 +0200 Subject: [PATCH 07/16] Taking into account comments on merge request !3. --- README.md | 31 +++++++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6a9a01df1..05950724a 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,26 @@ quick studies up to critical operations. As a library, Orekit provides basic elements (orbits, dates, attitude, frames, ...) and various algorithms to handle them (conversions, propagations, pointing, ...). +## Download + +### Official releases + +[Official Orekit releases](https://gitlab.orekit.org/orekit/orekit/releases) +are available on our [Gitlab instance](https://gitlab.orekit.org/). They are +also available in the +[Maven repository](https://mvnrepository.com/artifact/org.orekit/orekit). + +### Development version + +To get the latest development version, please clone our official repository +and checkout the `develop` branch: + +```bash +git clone -b develop https://gitlab.orekit.org/orekit/orekit.git +``` +__Note:__ Our official repository is +[mirrored on Github](https://github.com/CS-SI/Orekit). + ## Documentation Project overview, architecture and development, detailed features list, @@ -24,6 +44,9 @@ can report bugs and suggest new features in our ## Contributing +Orekit exists thanks to the contribution of +[many people](https://gitlab.orekit.org/orekit/orekit/graphs/develop). + If you are interested in participating in the development effort, subscribe to the [forum](https://forum.orekit.org/) and step up to discuss it. The larger the community is, the better Orekit will be. The main rule is that everything @@ -39,10 +62,6 @@ More information is available in our Detailed information on how to build Orekit from source either using Maven or Eclipse is provided in [building.md](src/site/markdown/building.md) file. -[Official Orekit artifacts](https://mvnrepository.com/artifact/org.orekit/orekit) -are available on Maven public repository and on the -[Orekit web site](http://orekit.org/download.html). - * The [src/main/java](src/main/java) directory contains the library sources. * The [src/main/resources](src/main/resources) directory contains the library data. @@ -55,7 +74,7 @@ are available on Maven public repository and on the example data. * The [src/design](src/design) directory contains pieces for a UML model of the library. - + ## Dependencies Orekit relies on the following free software, all released under business @@ -70,7 +89,7 @@ friendly free licenses. * [JUnit 4](http://www.junit.org/) from Erich Gamma and Kent Beck released under the Eclipse Public License, version 1.0 - + * [Mockito](https://site.mockito.org/) from Szczepan Faber and others, released under MIT license. -- GitLab From 81e480fb1062be29e11d270bb082ecec1d4aa1a8 Mon Sep 17 00:00:00 2001 From: Sebastien Dinot Date: Thu, 2 May 2019 23:09:29 +0200 Subject: [PATCH 08/16] Removed source tree description, useless in the README file. --- README.md | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/README.md b/README.md index 05950724a..996144c92 100644 --- a/README.md +++ b/README.md @@ -62,19 +62,6 @@ More information is available in our Detailed information on how to build Orekit from source either using Maven or Eclipse is provided in [building.md](src/site/markdown/building.md) file. -* The [src/main/java](src/main/java) directory contains the library sources. -* The [src/main/resources](src/main/resources) directory contains the library - data. -* The [src/test/java](src/test/java) directory contains the tests sources. -* The [src/test/resources](src/test/resources) directory contains the tests - data. -* The [src/tutorials/java](src/tutorials/java) directory contains sources for - example use of the library. -* The [src/tutorials/resources](src/tutorials/resources) directory contains - example data. -* The [src/design](src/design) directory contains pieces for a UML model of - the library. - ## Dependencies Orekit relies on the following free software, all released under business -- GitLab From 7059b7438132d5369be9b3f68ef808c161877f64 Mon Sep 17 00:00:00 2001 From: Sebastien Dinot Date: Thu, 2 May 2019 23:10:46 +0200 Subject: [PATCH 09/16] Corrected spelling mistake in the naming of the license --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 996144c92..e0455617d 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ If you are interested in participating in the development effort, subscribe to the [forum](https://forum.orekit.org/) and step up to discuss it. The larger the community is, the better Orekit will be. The main rule is that everything intended to be included in Orekit core must be distributed under the Apache -License Version 2.0 (you will be asked to sign a contributor license +License, version 2.0 (you will be asked to sign a contributor license agreement). More information is available in our @@ -86,5 +86,5 @@ More detailed information is available in the ## License Orekit is licensed by [CS Systèmes d'Information](https://www.c-s.fr/) under -the [Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html). +the [Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html). A copy of this license is provided in the [LICENSE.txt](LICENSE.txt) file. -- GitLab From 9e97af74a03dba828beb08c9bb1f9f198dd3f6ea Mon Sep 17 00:00:00 2001 From: Sebastien Dinot Date: Thu, 2 May 2019 23:11:31 +0200 Subject: [PATCH 10/16] Added short description of dependencies --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e0455617d..07487968c 100644 --- a/README.md +++ b/README.md @@ -64,20 +64,21 @@ Eclipse is provided in [building.md](src/site/markdown/building.md) file. ## Dependencies -Orekit relies on the following free software, all released under business -friendly free licenses. +Orekit relies on the following +[FOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software) libraries, +all released under business friendly FOSS licenses. ### Compile-time/run-time dependencies -* [Hipparchus](https://hipparchus.org/) from the Hipparchus project released - under the Apache Software License, version 2 +* [Hipparchus](https://hipparchus.org/), a mathematics library released under + the Apache License, version 2.0 ### Test-time dependencies -* [JUnit 4](http://www.junit.org/) from Erich Gamma and Kent Beck released +* [JUnit 4](http://www.junit.org/), a widely used unit test framework released under the Eclipse Public License, version 1.0 -* [Mockito](https://site.mockito.org/) from Szczepan Faber and others, +* [Mockito](https://site.mockito.org/), a mocking framework for unit tests, released under MIT license. More detailed information is available in the -- GitLab From 5db836b1166bc7afbb29c8bf30c38ca64f493f03 Mon Sep 17 00:00:00 2001 From: Sebastien Dinot Date: Thu, 2 May 2019 23:14:16 +0200 Subject: [PATCH 11/16] Added missing periods --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 07487968c..216139a1c 100644 --- a/README.md +++ b/README.md @@ -71,12 +71,12 @@ all released under business friendly FOSS licenses. ### Compile-time/run-time dependencies * [Hipparchus](https://hipparchus.org/), a mathematics library released under - the Apache License, version 2.0 + the Apache License, version 2.0. ### Test-time dependencies * [JUnit 4](http://www.junit.org/), a widely used unit test framework released - under the Eclipse Public License, version 1.0 + under the Eclipse Public License, version 1.0. * [Mockito](https://site.mockito.org/), a mocking framework for unit tests, released under MIT license. -- GitLab From c6bd2c71d74a99520ea9527f4770666303121e93 Mon Sep 17 00:00:00 2001 From: Sebastien Dinot Date: Fri, 3 May 2019 10:13:59 +0200 Subject: [PATCH 12/16] Contributing instructions should be given in the dedicated file --- README.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 216139a1c..5a5d22156 100644 --- a/README.md +++ b/README.md @@ -47,15 +47,9 @@ can report bugs and suggest new features in our Orekit exists thanks to the contribution of [many people](https://gitlab.orekit.org/orekit/orekit/graphs/develop). -If you are interested in participating in the development effort, subscribe to -the [forum](https://forum.orekit.org/) and step up to discuss it. The larger -the community is, the better Orekit will be. The main rule is that everything -intended to be included in Orekit core must be distributed under the Apache -License, version 2.0 (you will be asked to sign a contributor license -agreement). - -More information is available in our -[development guidelines](https://www.orekit.org/site-orekit-development/guidelines.html). +Please take a look at our +[contributing guidelines](src/site/markdown/contributing.md) if you're +interested in helping! ## Building -- GitLab From 191d3d6f4bf1570c909f4fee6d418c48b7cd3782 Mon Sep 17 00:00:00 2001 From: Sebastien Dinot Date: Fri, 3 May 2019 10:17:25 +0200 Subject: [PATCH 13/16] Concatenate two related sentences in one paragraph. --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 5a5d22156..94eaf756f 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,6 @@ can report bugs and suggest new features in our Orekit exists thanks to the contribution of [many people](https://gitlab.orekit.org/orekit/orekit/graphs/develop). - Please take a look at our [contributing guidelines](src/site/markdown/contributing.md) if you're interested in helping! -- GitLab From 4e0e3422590806d77b93c4efe361ffe295a8146c Mon Sep 17 00:00:00 2001 From: Sebastien Dinot Date: Fri, 3 May 2019 14:36:56 +0200 Subject: [PATCH 14/16] Add CONTRIBUTING.md file in accordance with the recommended practices --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..4106fb47a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,6 @@ +# Contributing + +This project is documented through a static site generated by Maven. +Contributing information are described in the +[contributing guidelines](src/site/markdown/contributing.md) +inside the Maven site. -- GitLab From aaae446fd518f50da24083e46b2937461fc29128 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Dinot?= Date: Fri, 3 May 2019 14:44:10 +0200 Subject: [PATCH 15/16] Correct spelling mistake --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4106fb47a..6836bbf4e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing This project is documented through a static site generated by Maven. -Contributing information are described in the +Contributing information is described in the [contributing guidelines](src/site/markdown/contributing.md) inside the Maven site. -- GitLab From a1e99dabb419c530a74fe7a2d7f9614fc8c5e081 Mon Sep 17 00:00:00 2001 From: Sebastien Dinot Date: Sat, 4 May 2019 11:46:53 +0200 Subject: [PATCH 16/16] Add CONTRIBUTING.md to source distribution archive --- src/main/assembly/source-distribution-assembly.xml | 1 + 1 file changed, 1 insertion(+) diff --git a/src/main/assembly/source-distribution-assembly.xml b/src/main/assembly/source-distribution-assembly.xml index 87f961088..0c5d3978c 100644 --- a/src/main/assembly/source-distribution-assembly.xml +++ b/src/main/assembly/source-distribution-assembly.xml @@ -10,6 +10,7 @@ LICENSE.txt NOTICE.txt BUILDING.txt + CONTRIBUTING.md pom.xml build.xml checkstyle.xml -- GitLab