Deploy preview for PR 14 🛫

pr-preview/pr-14/README.md

@@ -0,0 +1,34 @@
+# RTS Development Guidelines
+
+A guide for promoting best practices among RTS code repositories.
+
+## Introduction
+
+The software industry is constantly evolving. Our own practices should similarly evolve to
+disseminate knowledge throughout teams, share ownership, make it easier for newcomers to start and
+for seasoned developers to contribute to any project.
+
+## Guides
+
+The following guides are offered to help you improve your repository:
+
+- [Readme Guide](./guides/README_GUIDE.md): Write a great introductory text for your repository.
+- [Contributing Guide](./guides/CONTRIBUTING_GUIDE.md): Ensure smooth collaboration and
+  contribution to your project.
+- [Code of Conduct Guide](./guides/CODE_OF_CONDUCT_GUIDE.md): Provide guidelines to ensure
+  everyone can safely contribute.
+- [License Guide](./guides/LICENSE_GUIDE.md): Pick an appropriate license.
+
+> [!TIP]
+> GitHub Community Standards are a great source of information and best practices. You can check
+> that your project follows these standards at any time by checking _Community Standards_ under the
+_Insights_ section.
+
+More sources are available online for further reading; you can start exploring them
+at [opensource.guide](https://opensource.guide/).
+
+[open-issues]: https://github.com/SRGSSR/guilde-plateformes-propres/issues/new
+
+[submit-pr]: https://github.com/SRGSSR/guilde-plateformes-propres/compare
+
+[discussions]: https://github.com/SRGSSR/guilde-plateformes-propres/discussions

pr-preview/pr-14/_sidebar.md

@@ -0,0 +1,10 @@
+<!-- docs/_sidebar.md -->
+<img src="img/rts-logo.svg" alt="RTS" height="25"/> Development Guidelines
+* [Home](/)
+
+**Guides**
+
+* [Crafting a Readme](/guides/README_GUIDE.md)
+* [Understanding Licenses](/guides/LICENSE_GUIDE.md)
+* [Contributor's Handbook](/guides/CONTRIBUTING_GUIDE.md)
+* [Code of Conduct Guidelines](/guides/CODE_OF_CONDUCT_GUIDE.md)

pr-preview/pr-14/guides/CODE_OF_CONDUCT_GUIDE.md

@@ -0,0 +1,20 @@
+# Code of Conduct Guide
+
+Promote a welcoming and safe environment for discussions and contributions.
+
+> [!TIP]
+> More information is available from [GitHub documentation][github-documentation].
+
+## Picking a Code of Conduct
+
+The [Contributor Covenant][contributor-covenant] provides a great Code of Conduct. You can use it
+as-is, adapt it to your needs, or write your own document.
+
+## Adding a Code of Conduct
+
+Add a file called `CODE_OF_CONDUCT.md` to the root of your repository, the `docs` folder, or
+the `.github` folder, with the text of the Code of Conduct you chose. GitHub automatically adds a
+link to this file in the _About_ section of your repository homepage.
+
+[github-documentation]: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project
+[contributor-covenant]: https://www.contributor-covenant.org/

pr-preview/pr-14/guides/CONTRIBUTING_GUIDE.md

@@ -0,0 +1,27 @@
+# Contributing Guide
+
+Provide more context about contributions you are looking for and how they should occur.
+
+> [!TIP]
+> More information is available from [GitHub documentation][github-documentation].
+
+## Writing Contributing guidelines
+
+Writing Contributing guidelines depends on your project and how your team decides to process
+contributions. To help you:
+
+- The [Pillarbox Contributing guidelines][pillarbox-contributing] is an example describing which
+  contributions are considered, how they should occur (with links to the corresponding templates)
+  and how they will be processed.
+- The following [template][contributing-template] can be used if you need to write Contributing
+  guidelines tailored to your needs.
+
+## Adding Contributing guidelines
+
+Add a file called `CONTRIBUTING.md` to the root of your repository, the `docs` folder, or
+the `.github` folder, with the text you wrote. GitHub automatically adds a link to this file in the
+_About_ section of your repository homepage.
+
+[github-documentation]: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors
+[pillarbox-contributing]: https://github.com/SRGSSR/pillarbox-apple/blob/main/docs/CONTRIBUTING.md
+[contributing-template]: https://github.com/nayafia/contributing-template

pr-preview/pr-14/guides/LICENSE_GUIDE.md

@@ -0,0 +1,33 @@
+# License Guide
+
+Make applicable license conditions transparent.
+
+> [!TIP]
+> More information is available from [GitHub documentation][github-documentation].
+
+## Choosing a license
+
+The following [online guide](https://choosealicense.com/) is an excellent way to pick a license.
+
+## Adding a license
+
+Add a file called `LICENSE` to the root of your repository, the `docs` folder, or the `.github`
+folder, with the text of the license you chose. GitHub automatically adds a link to this file in the
+_About_ section of your repository homepage.
+
+You can either repeat the license in each file requiring it but this is generally cumbersome. To
+make your life easier you can use the following reduced license instead, which points to the main
+license file for more information:
+
+```
+//
+//  Copyright (c) SRG SSR. All rights reserved.
+//
+//  License information is available from the LICENSE file.
+//
+```
+
+Avoid dates in license information since they have no real values and are likely never correctly
+updated.
+
+[github-documentation]: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository

pr-preview/pr-14/guides/README_GUIDE.md

@@ -0,0 +1,95 @@
+# Crafting a Readme
+
+A well-structured and informative README is more than just documentation; it's a powerful tool for
+collaboration. Your README serves as the gateway for developers to understand and contribute to your
+project.
+
+## Why it Matters
+
+- **Reduces Barriers to Entry:** A clear and welcoming README lowers the learning curve, making it
+  easier for new contributors to understand the project and start contributing.
+- **Encourages Contribution:** By providing explicit guidelines on how to contribute, your README
+  becomes an invitation for developers to actively participate in the project.
+- **Fosters Transparency:** A well-crafted README sets the tone for open and transparent
+  communication.
+
+## The Template
+
+This template will assist you in creating a compelling and concise README for your project. It
+provides step-by-step guidance on introducing your project and providing essential information for
+setting up and running your application.
+
+> [!Tip]
+> Enhance your project's visual appeal with a representative image and badges.
+> Explore [Adding workflow badges][workflow-badges] for guidance. If your project is an application,
+> include production version links (e.g., app store links) and incorporate screenshots to showcase
+> its appearance.
+
+> [!Warning]
+> Avoid adding a table of contents unless it serves a specific purpose, as GitHub generates one
+> automatically.
+
+---
+
+```markdown
+# <Project Name>
+
+> Introduce your project with a clear overview of its goals, providing
+> essential context and addressing fundamental questions.
+
+## Quick Guide
+
+**Prerequisites and Requirements**
+
+> List any prerequisites or requirements needed before setting up the project.
+
+**Running the Application**
+
+> Provide instructions on running the application locally for application projects.
+
+> For libraries, components, or frameworks, explain a typical setup, including
+> installation from a package distribution manager and a simple use case.
+> Avoid detailed development environment setup in this section.
+
+## Documentation
+
+> Include links to additional documentation resources related to your project in
+> this section.
+
+## Contributing
+
+> Clarify how others can contribute to the project, with guidelines for bug
+> reports, feature requests, or code contributions. Add a link to the Contribution
+> guidelines.
+
+> Describe any automated processes that facilitate smoother collaboration.
+> For instance, explain how to run linting tools. No need to justify conventions;
+> simply enumerate them.
+
+> For libraries, components, or frameworks, explain how to set up a local
+> environment for development. Avoid detailing this in the 'Quick Guide' section.
+
+## License
+
+> Provide a link to the License.
+
+## Acknowledgements
+
+> Give credit to third-party libraries, tools, or individuals whose work is used
+> or inspired your project.
+```
+
+---
+
+> [!Note]
+> Customize this template according to the specific needs of your projects. Add or remove sections
+> based on the nature of each project.
+
+
+[workflow-badges]: https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge
+
+## Further Reading
+
+For more detailed information on specific topics not covered in this README, consider exploring the
+following articles: [Contributor's Handbook](./CONTRIBUTING_GUIDE.md)
+and [Understanding Licenses](./LICENSE_GUIDE.md).

pr-preview/pr-14/index.html

@@ -0,0 +1,36 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>RTS Development Guidelines</title>
+    <link rel="shortcut icon" type="image/x-icon" href="https://www.rts.ch/hbv7/static/images/favicon/rts/favicon.ico">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"/>
+    <meta name="description" content="Description">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+    <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple-dark.css">
+    <style>
+        .sidebar-nav > p {
+            display: flex;
+            align-items: center;
+            justify-content: space-between;
+        }
+    </style>
+</head>
+<body>
+<div id="app"></div>
+<script>
+    window.$docsify = {
+        repo: 'https://github.com/SRGSSR/guilde-plateformes-propres',
+        auto2top: true,
+        relativePath: true,
+        loadSidebar: true,
+        themeColor: '#00af91',
+        subMaxLevel: 2
+    }
+</script>
+<!-- Docsify v4 -->
+<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+<script src="//unpkg.com/docsify-plugin-flexible-alerts"></script>
+<script src="//cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js"></script>
+</body>
+</html>