[libcamera-devel,v1,2/5] Documentation: code-of-conduct: Convert to reStructuredText
diff mbox series

Message ID 20231110142311.3818-3-laurent.pinchart@ideasonboard.com
State Accepted
Headers show
Series
  • Add a code of conduct to libcamera
Related show

Commit Message

Laurent Pinchart Nov. 10, 2023, 2:23 p.m. UTC
All documentation in libcamera is in reStructuredText format. Convert
the code of conduct from Markdown. No change in the contents is
intended.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 ...code_of_conduct.md => code-of-conduct.rst} | 25 ++++++++++++-------
 1 file changed, 16 insertions(+), 9 deletions(-)
 rename Documentation/{code_of_conduct.md => code-of-conduct.rst} (89%)

Comments

Kieran Bingham Nov. 24, 2023, 3:27 p.m. UTC | #1
Quoting Laurent Pinchart via libcamera-devel (2023-11-10 14:23:08)
> All documentation in libcamera is in reStructuredText format. Convert
> the code of conduct from Markdown. No change in the contents is
> intended.

Having to convert, rather than keep it original is a pain, but it
probably makes more sense to keep a single format style for libcamera so
I think this is ok.



> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
>  ...code_of_conduct.md => code-of-conduct.rst} | 25 ++++++++++++-------
>  1 file changed, 16 insertions(+), 9 deletions(-)
>  rename Documentation/{code_of_conduct.md => code-of-conduct.rst} (89%)
> 
> diff --git a/Documentation/code_of_conduct.md b/Documentation/code-of-conduct.rst
> similarity index 89%
> rename from Documentation/code_of_conduct.md
> rename to Documentation/code-of-conduct.rst
> index fcf453902224..b7aa9b3879e3 100644
> --- a/Documentation/code_of_conduct.md
> +++ b/Documentation/code-of-conduct.rst
> @@ -1,7 +1,9 @@
>  
> -# Contributor Covenant Code of Conduct
> +Contributor Covenant Code of Conduct
> +====================================
>  
> -## Our Pledge
> +Our Pledge
> +----------
>  
>  In the interest of fostering an open and welcoming environment, we as
>  contributors and maintainers pledge to make participation in our project and
> @@ -10,7 +12,8 @@ size, 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.
>  
> -## Our Standards
> +Our Standards
> +-------------
>  
>  Examples of behavior that contributes to creating a positive environment
>  include:
> @@ -32,7 +35,8 @@ Examples of unacceptable behavior by participants include:
>  * Other conduct which could reasonably be considered inappropriate in a
>    professional setting
>  
> -## Our Responsibilities
> +Our Responsibilities
> +--------------------
>  
>  Project maintainers are responsible for clarifying the standards of acceptable
>  behavior and are expected to take appropriate and fair corrective action in
> @@ -44,7 +48,8 @@ that are not aligned to this Code of Conduct, or to ban temporarily or
>  permanently any contributor for other behaviors that they deem inappropriate,
>  threatening, offensive, or harmful.
>  
> -## Scope
> +Scope
> +-----
>  
>  This Code of Conduct applies within all project spaces, and it also applies when
>  an individual is representing the project or its community in public spaces.
> @@ -53,7 +58,8 @@ project e-mail address, posting via an official social media account, or acting
>  as an appointed representative at an online or offline event. Representation of
>  a project may be further defined and clarified by project maintainers.
>  
> -## Enforcement
> +Enforcement
> +-----------
>  
>  Instances of abusive, harassing, or otherwise unacceptable behavior may be
>  reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
> @@ -66,12 +72,13 @@ 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.
>  
> -## Attribution
> +Attribution
> +-----------
>  
> -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
> +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
>  
> -[homepage]: https://www.contributor-covenant.org
> +.. _Contributor Covenant: https://www.contributor-covenant.org
>  

Seems easy enough:


Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

>  For answers to common questions about this code of conduct, see
>  https://www.contributor-covenant.org/faq
> -- 
> Regards,
> 
> Laurent Pinchart
>

Patch
diff mbox series

diff --git a/Documentation/code_of_conduct.md b/Documentation/code-of-conduct.rst
similarity index 89%
rename from Documentation/code_of_conduct.md
rename to Documentation/code-of-conduct.rst
index fcf453902224..b7aa9b3879e3 100644
--- a/Documentation/code_of_conduct.md
+++ b/Documentation/code-of-conduct.rst
@@ -1,7 +1,9 @@ 
 
-# Contributor Covenant Code of Conduct
+Contributor Covenant Code of Conduct
+====================================
 
-## Our Pledge
+Our Pledge
+----------
 
 In the interest of fostering an open and welcoming environment, we as
 contributors and maintainers pledge to make participation in our project and
@@ -10,7 +12,8 @@  size, 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.
 
-## Our Standards
+Our Standards
+-------------
 
 Examples of behavior that contributes to creating a positive environment
 include:
@@ -32,7 +35,8 @@  Examples of unacceptable behavior by participants include:
 * Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
-## Our Responsibilities
+Our Responsibilities
+--------------------
 
 Project maintainers are responsible for clarifying the standards of acceptable
 behavior and are expected to take appropriate and fair corrective action in
@@ -44,7 +48,8 @@  that are not aligned to this Code of Conduct, or to ban temporarily or
 permanently any contributor for other behaviors that they deem inappropriate,
 threatening, offensive, or harmful.
 
-## Scope
+Scope
+-----
 
 This Code of Conduct applies within all project spaces, and it also applies when
 an individual is representing the project or its community in public spaces.
@@ -53,7 +58,8 @@  project e-mail address, posting via an official social media account, or acting
 as an appointed representative at an online or offline event. Representation of
 a project may be further defined and clarified by project maintainers.
 
-## Enforcement
+Enforcement
+-----------
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
@@ -66,12 +72,13 @@  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.
 
-## Attribution
+Attribution
+-----------
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+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
 
-[homepage]: https://www.contributor-covenant.org
+.. _Contributor Covenant: https://www.contributor-covenant.org
 
 For answers to common questions about this code of conduct, see
 https://www.contributor-covenant.org/faq