docs: Add community documents

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
+.
+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,41 @@
+# Contributing to FlowPair
+
+We take Pull Requests!
+
+## Before you send Pull Request
+
+1. Contact the contributors via the [Github Issue](https://github.com/skarllot/flow-pair/issues/new/choose) to make sure that this is issue or bug should be handled with proposed way. Send details of your case and explain the details of the proposed solution.
+2. Once you get approval from one of the maintainers, you can start to work on your code change.
+3. After your changes are ready, make sure that you covered your case with automated tests and verify that you have limited the number of breaking changes to a bare minimum.
+4. We also highly appreciate any relevant updates to the documentation.
+5. Make sure that your code is compiling and all automated tests are passing.
+
+## After you have sent Pull Request
+
+1. Make sure that you applied or answered all the feedback from the maintainers.
+2. Pull request will be merged when you get approvals from at least 1 of the maintainers (and no rejection from others).
+
+## Working with the Git
+
+1. Fork the repository.
+2. Create a feature branch from the `main` branch.
+3. We're not squashing the changes and using rebase strategy for our branches (see more in [Git documentation](https://git-scm.com/book/en/v2/Git-Branching-Rebasing)). Having that, we highly recommend using clear commit messages. Commits should also represent the unit of change.
+4. The commits must follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/).
+5. Before sending PR to make sure that you rebased the latest `main` branch from the FlowPair repository.
+6. When you're ready to create the [Pull Request on GitHub](https://github.com/skarllot/flow-pair/compare).
+
+## Code style
+
+Coding rules are set up in the [.editorconfig file](.editorconfig). This file is supported by all popular IDE (eg. Microsoft Visual Studio, Rider, Visual Studio Code) so if you didn't disabled it manually they should be automatically applied after opening the solution. We also recommend turning automatic formatting on saving to have all the rules applied.
+
+## Licensing and legal rights
+
+By contributing to FlowPair:
+
+1. You assert that contribution is your original work.
+2. You assert that you have the right to assign the copyright for the work.
+3. You are accepting the [License](LICENSE).
+
+## Code of Conduct
+
+This project has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/) to clarify expected behavior in our community.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Fabrício Godoy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,85 @@
+# FlowPair
+
+_FlowPair provides automated code review and feedback using CI&T Flow AI through a command-line interface._
+
+[![GitHub Release](https://img.shields.io/github/v/release/skarllot/flow-pair)](https://github.com/skarllot/flow-pair/releases)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://raw.githubusercontent.com/skarllot/flow-pair/main/LICENSE)
+
+<hr />
+
+## About
+
+FlowPair is a CLI tool that leverages CI&T's Flow AI to provide automated code reviews. It detects Git staged (or unstaged) changes and generates insightful feedback, enhancing your development process with AI-powered assistance.
+
+## Features
+
+- Automated code review for Git changes
+- AI-powered feedback generation
+- HTML report output for easy review
+- Simple configuration and usage
+
+## Installation
+
+1. Download the latest version of FlowPair from the [releases page](https://github.com/skarllot/flow-pair/releases).
+
+2. Extract the downloaded archive to a directory of your choice.
+
+3. Add the FlowPair directory to your system's PATH.
+
+4. Open a terminal and run the following command to verify the installation:
+```
+flowpair --version
+```
+
+## Configuration
+
+To configure FlowPair, run:
+```
+flowpair configure
+```
+
+You will be prompted to provide the following information:
+
+- Tenant
+- Client ID
+- Client Secret
+
+These credentials are necessary for authenticating with the CI&T Flow AI service.
+
+## Usage
+
+To review your Git changes and receive feedback, simply run:
+```
+flowpair review
+```
+
+This command will:
+1. Detect Git staged (or unstaged) changes in your current repository
+2. Send the changes to CI&T Flow AI for review
+3. Generate an HTML file with the feedback
+
+The HTML report will be saved in your current directory for easy access and review.
+
+## Documentation
+
+For more detailed information on how to use FlowPair and its features, please refer to our [GitHub wiki](https://github.com/skarllot/flow-pair/wiki).
+
+## Contributing
+
+We welcome contributions to FlowPair! If you have suggestions for improvements or encounter any issues, please feel free to:
+
+- Open an [issue](https://github.com/skarllot/flow-pair/issues)
+- Submit a [pull request](https://github.com/skarllot/flow-pair/pulls)
+
+Before contributing, please read our [contribution guidelines](CONTRIBUTING.md).
+
+## Support
+
+If you need help or have any questions, please:
+
+- Check our [GitHub Issues](https://github.com/skarllot/flow-pair/issues) for existing problems or to report new ones
+- Contact the maintainer at [skarllot@gmail.com](mailto:skarllot@gmail.com)
+
+## License
+
+FlowPair is licensed under the [MIT License](./LICENSE).

SECURITY.md

@@ -0,0 +1,7 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+To privately report a security vulnerability, please create a security advisory in the [repository's Security tab](https://github.com/skarllot/flow-pair/security/advisories).
+
+Further details can be found in the [GitHub documentation](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).