add CONTRIBUTING.md & SECURITY.md & update README.md

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# 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 the community leaders responsible for enforcement at
+[email protected].
+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,68 @@
+# Contributing Guidelines
+
+Hey there! If you've landed here, chances are you're interested in lending a hand to this project, and for that, we're incredibly grateful! Before you dive in, let's go over some ground rules and guidelines to ensure your contribution is smooth sailing. Thank you in advance for your help!
+
+## Ways to Contribute
+
+There are several ways you can contribute to this project:
+
+1. **Report Issues:** If you encounter any bugs, have suggestions for improvements, or would like to request new features, please open an issue on the [issue tracker](lhttps://github.com/tchapacan/livebox-exporter-rs/issues/new). Make sure to provide detailed information about the problem or feature request to help us understand and address it effectively.
+
+2. **Submit Pull Requests (PRs):** If you have code changes or improvements you'd like to contribute, you can fork the repository, make your changes, and then submit a pull request for review. We welcome all kinds of contributions, including bug fixes, feature enhancements, documentation improvements, and more.
+
+## Getting Started
+
+Before you start contributing, here's a quick guide to help you get started:
+
+1. **Fork the Repository:** Click the "Fork" button on the GitHub repository to create your own fork of the project.
+
+2. **Clone the Repository:** Clone your fork of the repository to your local machine.
+
+    ```bash
+    git clone https://github.com/your-username/livebox-exporter-rs.git
+    ```
+
+3. **Create a Branch:** Create a new branch for your changes. Choose a descriptive name for your branch that reflects the nature of your changes.
+
+    ```bash
+    git checkout -b feat/my-banger-new-feature
+    ```
+
+4. **Make Changes:** Make your desired changes to the codebase. Ensure that your changes adhere to the project's coding standards and guidelines.
+
+5. **Commit Changes:** Once you've made your changes, commit them to your branch with descriptive commit messages.
+
+    ```bash
+    git add .
+    git commit -m "Add your descriptive commit message here"
+    ```
+
+6. **Push Changes:** Push your changes to your forked repository on GitHub.
+
+    ```bash
+    git push origin feat/my-banger-new-feature
+    ```
+
+7. **Submit Pull Request:** Finally, submit a pull request from your forked repository to the main repository. Provide a clear and concise description of your changes in the pull request, along with any relevant details.
+
+## Code Style and Guidelines
+
+To maintain consistency and readability across the codebase, please adhere to the following guidelines:
+
+- **Coding Standards:** Follow the coding standards and conventions used in the project. If unsure, refer to existing code for guidance.
+- **Documentation:** Update documentation and README files as needed (depending of the work done)
+- **Testing:** Write tests for new features and ensure that existing tests pass before submitting a pull request please.
+
+## Code Review Process
+
+All pull requests will undergo code review by project maintainers/contributors. During code review, feedback may be provided to suggest improvements or address any issues. Contributors are expected to address feedback and make necessary changes before their pull requests can be merged.
+
+## Contribution License
+
+By contributing to this project, you agree to license your contributions under the same license as the project.
+
+## Get Help
+
+If you have any questions or need any help, feel free to reach out to us via [[email protected]](mailto:[email protected]) or by opening an issue on the GitHub repository.
+
+Thank you for your contributions and your help!

README.md

@@ -113,8 +113,9 @@ Options:
 Contributions are really welcome! If you encounter any issues, have suggestions, or would like to add/fix features, please do:
 
 - Open an issue to report bugs or request features.
-- Fork the repository, make your changes, and submit a pull request.
-- Contribution guidelines will be added soon.
+- Fork the repository, create your branch, make your changes, and submit a pull request.
+
+For more details here are the [contribution guidelines](CONTRIBUTING.md)
 
 
 ## Alternatives

SECURITY.md

@@ -0,0 +1,14 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.x.x   | :white_check_mark: |
+
+
+## Reporting a Vulnerability
+
+To report a security issue, please publish a [private security advisory](https://github.com/tchapacan/livebox-exporter-rs/security/advisories/new) with a description of the issue, the steps you took to create the issue, affected versions, and, if known, mitigations for the issue.
+
+We will respond within one week and follow up on weekly basis. If the issue is confirmed as a vulnerability, we will open a Security Advisory and acknowledge your contributions as part of it. This project follows a 90 day disclosure timeline.