Merge branch 'main' into adm/stabilization

AUTHORS.md

@@ -0,0 +1,25 @@
+# Authors
+
+`JustRelax.jl`'s development is coordinated by a group of *principal developers*,
+who are also its main contributors and who can be contacted in case of
+questions about `JustRelax.jl`. In addition, there are *contributors* who have
+provided substantial additions or modifications. Together, these two groups form
+"The JustRelax.jl Authors".
+
+## Principal Developers
+* [Albert de Montserrat](https://github.com/albert-de-montserrat),
+  Institute for Geophysics, ETH Zurich, Switzerland
+* [Pascal Aellig](https://github.com/aelligp),
+  Institute for Geosciences, Johannes Gutenberg University Mainz, Germany
+
+
+## Contributors
+The following people contributed major additions or modifications to `JustRelax.jl` and
+are listed in alphabetical order:
+
+* Sidney Beeler
+* Lukas Fuchs
+* Boris Kaus
+* Patrick Sanan
+* Hendrik Ranocha
+* Ludovic Räss

CODE_OF_CONDUCT.md

@@ -0,0 +1,131 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to
+[Albert de Montserrat](https://github.com/albert-de-montserrat),
+[Pascal Aellig](https://github.com/aelligp),
+or any other of the principal developers responsible for enforcement listed in
+[AUTHORS.md](AUTHORS.md).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,53 @@
+# Contributing
+
+JustRelax.jl is an open-source project and we are very happy to accept contributions
+from the community. Please feel free to open issues or submit patches (preferably
+as pull requests) any time. For planned larger contributions, it is often
+beneficial to get in contact with one of the principal developers first (see
+[AUTHORS.md](AUTHORS.md)).
+
+JustRelax.jl and its contributions are licensed under the MIT license. As a contributor, you certify that all your
+contributions are in conformance with the *Developer Certificate of Origin
+(Version 1.1)*, which is reproduced below.
+
+## Developer Certificate of Origin (Version 1.1)
+The following text was taken from
+[https://developercertificate.org](https://developercertificate.org):
+
+    Developer Certificate of Origin
+    Version 1.1
+
+    Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+    1 Letterman Drive
+    Suite D4700
+    San Francisco, CA, 94129
+
+    Everyone is permitted to copy and distribute verbatim copies of this
+    license document, but changing it is not allowed.
+
+
+    Developer's Certificate of Origin 1.1
+
+    By making a contribution to this project, I certify that:
+
+    (a) The contribution was created in whole or in part by me and I
+        have the right to submit it under the open source license
+        indicated in the file; or
+
+    (b) The contribution is based upon previous work that, to the best
+        of my knowledge, is covered under an appropriate open source
+        license and I have the right under that license to submit that
+        work with modifications, whether created in whole or in part
+        by me, under the same open source license (unless I am
+        permitted to submit under a different license), as indicated
+        in the file; or
+
+    (c) The contribution was provided directly to me by some other
+        person who certified (a), (b) or (c) and I have not modified
+        it.
+
+    (d) I understand and agree that this project and the contribution
+        are public and that a record of the contribution (including all
+        personal information I submit with it, including my sign-off) is
+        maintained indefinitely and may be redistributed consistent with
+        this project or the open source license(s) involved.

LICENSE → LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Pseudo-Transient solvers
+Copyright (c) 2021 Albert de Montserrat, Pascal Aellig and Authors (see [AUTHORS.md](AUTHORS.md))
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Project.toml

@@ -1,6 +1,6 @@
 name = "JustRelax"
 uuid = "34418575-392d-4e26-8c6d-96b0910afa06"
-authors = ["Albert De Montserrat <[email protected]>, Pascal Aellig <[email protected]> ,Patrick Sanan <[email protected]>"]
+authors = ["Albert De Montserrat <[email protected]>, Pascal Aellig <[email protected]>"]
 version = "0.2.1"
 
 [deps]

docs/make.jl

@@ -1,10 +1,72 @@
 using Documenter, JustRelax
 push!(LOAD_PATH, "../src/")
 
+# Get JustRelax.jl root directory
+JR_root_dir = dirname(@__DIR__)
+
+license = read(joinpath(JR_root_dir, "LICENSE.md"), String)
+write(joinpath(@__DIR__, "src", "man", "license.md"), license)
+
+# Copy list of authors to not need to synchronize it manually
+authors_text = read(joinpath(JR_root_dir, "AUTHORS.md"), String)
+# authors_text = replace(authors_text, "in the [LICENSE.md](LICENSE.md) file" => "under [License](@ref)")
+write(joinpath(@__DIR__, "src", "man", "authors.md"), authors_text)
+
+# Copy some files from the repository root directory to the docs and modify them
+# as necessary
+# Based on: https://github.com/ranocha/SummationByPartsOperators.jl/blob/0206a74140d5c6eb9921ca5021cb7bf2da1a306d/docs/make.jl#L27-L41
+open(joinpath(@__DIR__, "src", "man", "license.md"), "w") do io
+  # Point to source license file
+  println(io, """
+  ```@meta
+  EditURL = "https://github.com/PTsolvers/JustRelax.jl/blob/main/LICENSE.md"
+  ```
+  """)
+  # Write the modified contents
+  println(io, "# [License](@id license)")
+  println(io, "")
+  for line in eachline(joinpath(dirname(@__DIR__), "LICENSE.md"))
+    line = replace(line, "[AUTHORS.md](AUTHORS.md)" => "[Authors](@ref)")
+    println(io, "> ", line)
+  end
+end
+
+open(joinpath(@__DIR__, "src", "man", "code_of_conduct.md"), "w") do io
+  # Point to source license file
+  println(io, """
+  ```@meta
+  EditURL = "https://github.com/PTsolvers/JustRelax.jl/blob/main/CODE_OF_CONDUCT.md"
+  ```
+  """)
+  # Write the modified contents
+  println(io, "# [Code of Conduct](@id code-of-conduct)")
+  println(io, "")
+  for line in eachline(joinpath(dirname(@__DIR__), "CODE_OF_CONDUCT.md"))
+    line = replace(line, "[AUTHORS.md](AUTHORS.md)" => "[Authors](@ref)")
+    println(io, "> ", line)
+  end
+end
+
+open(joinpath(@__DIR__, "src", "man", "contributing.md"), "w") do io
+    # Point to source license file
+    println(io, """
+    ```@meta
+    EditURL = "https://github.com/PTsolvers/JustRelax.jl/blob/main/CONTRIBUTING.md"
+    ```
+    """)
+    # Write the modified contents
+    println(io, "# [Contributing](@id contributing)")
+    println(io, "")
+    for line in eachline(joinpath(dirname(@__DIR__), "CONTRIBUTING.md"))
+      line = replace(line, "[LICENSE.md](LICENSE.md)" => "[License](@ref)")
+      line = replace(line, "[AUTHORS.md](AUTHORS.md)" => "[Authors](@ref)")
+      println(io, "> ", line)
+    end
+  end
 @info "Making documentation..."
 makedocs(;
     sitename="JustRelax.jl",
-    authors="Albert de Montserrat and contributors",
+    authors="Albert de Montserrat, Pascal Aellig and contributors",
     modules=[JustRelax],
     format=Documenter.HTML(; prettyurls=get(ENV, "CI", nothing) == "true",
     size_threshold_ignore = ["man/listfunctions.md"]), # easier local build
@@ -29,6 +91,10 @@ makedocs(;
                 ]
             ],
         "List of functions" => "man/listfunctions.md",
+        "Authors" => "man/authors.md",
+        "Contributing" => "man/contributing.md",
+        "Code of Conduct" => "man/code_of_conduct.md",
+        "License" => "man/license.md"
     ],
 )