chore(repo) added standard repository guidelines

.mdl_style.rb

@@ -0,0 +1,7 @@
+all
+# Parameters: line_length, ignore_code_blocks, code_blocks, tables (number; default 80, boolean; default false, boolean; default true, boolean; default true)
+exclude_rule 'MD013'
+# default in next version, remove then
+rule 'MD007', :indent => 3
+
+rule "MD029", style => "one"

.mdlrc

@@ -0,0 +1 @@
+style '.mdl_style.rb'

CODEOWNERS

@@ -0,0 +1 @@
+* @hyp3rd

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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 email 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
+<conduct@hyp3rd.dev>.
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing Guidelines
+
+## How to Contribute
+
+### Reporting Issues
+
+One of the simplest ways to contribute is by reporting issues. If you encounter a problem with one of the tools, find a mistake in the documentation, or believe that a best practice needs to be updated, please open an issue on our GitHub repository.
+
+### Submitting Changes
+
+If you want to directly contribute to the project by adding new tools, updating documentation, or proposing new best practices, follow these steps:
+
+- **Fork the Repository:** Start by forking the project repository into your GitHub account.
+- **Create a Branch:** Create a new branch in your forked repository. It's good practice to name the branch according to the feature or fix you're implementing.
+- **Branch naming suggestion:** `feat/<scope>`, `fix/<scope>`, or `chore/<scope>`.
+- **Make Your Changes:** Add, edit, or delete files in your branch to implement the changes you want to make.
+- **Commit Your Changes:** Make sure to write clear, concise commit messages describing your changes.
+- **Push Your Changes:** Push your branch and its new commits to your forked repository on GitHub.
+- **Create a Pull Request:** Open a pull request from your forked repository to the main project repository. Please provide a detailed description of the changes you've made and the reasons behind them.
+
+## Reviewing Pull Requests
+
+Another way to contribute is by reviewing pull requests submitted by others. Look over the proposed changes, test them if possible, and leave feedback.
+
+## Contribution Guidelines
+
+To ensure that contributions are consistent and aligned with the project's objectives, please follow these guidelines:
+
+**Respect the Project's Scope:** All contributions should aim to improve the service stability, security, performance. Contributions that align with this objective may be accepted.
+
+**Follow Best Practices:** When contributing code, adhere to the coding style and practices established in the project.
+
+**Provide Detailed Information:** When reporting issues or submitting pull requests, provide as much relevant information as possible. This will help maintainers and other contributors understand your changes or your problems.
+
+**Ship with validation:** Run `make lint test` locally before raising a pull request. Include tests for new functionality and update documentation when tooling or workflows change.
+
+**Respect Others:** Be kind and respectful towards other community members. Avoid disrespectful language and behavior.