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

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.