From e8a6b94d082c9c275205ca6f8b7f1810e8f64500 Mon Sep 17 00:00:00 2001 From: "Vandenplas, Jeremie" Date: Sun, 24 May 2020 17:05:38 +0200 Subject: [PATCH 1/2] docreag --- API-doc-FORD-file.md | 33 +++++++++++++++++++++++++ doc/{ => contributing}/CodeOfConduct.md | 0 doc/{ => contributing}/StyleGuide.md | 0 doc/{ => contributing}/Workflow.md | 0 doc/contributing/index.md | 7 ++++++ doc/index.md | 2 +- 6 files changed, 41 insertions(+), 1 deletion(-) rename doc/{ => contributing}/CodeOfConduct.md (100%) rename doc/{ => contributing}/StyleGuide.md (100%) rename doc/{ => contributing}/Workflow.md (100%) create mode 100644 doc/contributing/index.md diff --git a/API-doc-FORD-file.md b/API-doc-FORD-file.md index 292fa6e8a..4658fc739 100644 --- a/API-doc-FORD-file.md +++ b/API-doc-FORD-file.md @@ -55,3 +55,36 @@ The documentation for comment markup in source code, running [FORD] and the [FOR [FORD]: https://github.com/Fortran-FOSS-Programmers/ford#readme [FORD wiki]: https://github.com/Fortran-FOSS-Programmers/ford/wiki [FORD project file]: https://github.com/fortran-lang/stdlib/blob/master/API-doc-FORD-file.md + +Goals and Motivation +==================== + +The Fortran Standard, as published by the ISO (https://wg5-fortran.org/), does +not have a Standard Library. The goal of this project is to provide a community +driven and agreed upon *de facto* "standard" library for Fortran, called a +Fortran Standard Library (`stdlib`). We have a rigorous process how `stdlib` is +developed as documented in our [Workflow](page/contributing/Workflow.html). `stdlib` is both a +specification and a reference implementation. We are cooperating with the +Fortran Standards Committee (e.g., the effort +[started](https://github.com/j3-fortran/fortran_proposals/issues/104) at the J3 +committee repository) and the plan is to continue working with the Committee in +the future (such as in the step 5. in the [Workflow](page/contributing/Workflow.html) document), so +that if the Committee wants to standardize some feature already available in `stdlib`, it would +base it on `stdlib`'s implementation. + +Scope +===== + +The goal of the Fortran Standard Library is to achieve the following general scope: + +* Utilities (containers, strings, files, OS/environment integration, unit + testing & assertions, logging, ...) +* Algorithms (searching and sorting, merging, ...) +* Mathematics (linear algebra, sparse matrices, special functions, fast Fourier + transform, random numbers, statistics, ordinary differential equations, + numerical integration, optimization, ...) + +License +======= + +The `stdlib` source code and related files and documentation are distributed under the [MIT license](page/License.html). diff --git a/doc/CodeOfConduct.md b/doc/contributing/CodeOfConduct.md similarity index 100% rename from doc/CodeOfConduct.md rename to doc/contributing/CodeOfConduct.md diff --git a/doc/StyleGuide.md b/doc/contributing/StyleGuide.md similarity index 100% rename from doc/StyleGuide.md rename to doc/contributing/StyleGuide.md diff --git a/doc/Workflow.md b/doc/contributing/Workflow.md similarity index 100% rename from doc/Workflow.md rename to doc/contributing/Workflow.md diff --git a/doc/contributing/index.md b/doc/contributing/index.md new file mode 100644 index 000000000..c19d62e9f --- /dev/null +++ b/doc/contributing/index.md @@ -0,0 +1,7 @@ +--- +title: Contributing +--- + +This page aims to prodive information that are useful for `stdlib` contributors. +Issues can be reported on [GitHub](https://github.com/fortran-lang/stdlib/issues). + diff --git a/doc/index.md b/doc/index.md index 788499305..4ea7dbb54 100644 --- a/doc/index.md +++ b/doc/index.md @@ -1,5 +1,5 @@ --- -title: Specs, examples & user docs +title: Contributing and specs --- @warning From 18088e3bd3f00d66135dec9a564110cca67331f0 Mon Sep 17 00:00:00 2001 From: "Vandenplas, Jeremie" Date: Mon, 25 May 2020 18:34:22 +0200 Subject: [PATCH 2/2] docreag: insert code of conduct on the front page --- API-doc-FORD-file.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/API-doc-FORD-file.md b/API-doc-FORD-file.md index 4658fc739..b14bcec2e 100644 --- a/API-doc-FORD-file.md +++ b/API-doc-FORD-file.md @@ -84,6 +84,11 @@ The goal of the Fortran Standard Library is to achieve the following general sco transform, random numbers, statistics, ordinary differential equations, numerical integration, optimization, ...) +Code of Conduct +=============== + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. Please read first [this Code of Conduct](./page/contributing/CodeOfConduct.html) + License =======