Merge pull request #59 from permitio/perpare-to-publish

Clean Repo to Release

.gitignore

@@ -5,3 +5,179 @@ coverage
 
 .idea
 .vscode
+
+# Local .terraform directories
+**/.terraform/*
+*.tf
+
+# .tfstate files
+*.tfstate
+*.tfstate.*
+
+# Crash log files
+crash.log
+crash.*.log
+
+# Exclude all .tfvars files, which are likely to contain sensitive data, such as
+# password, private keys, and other secrets. These should not be part of version 
+# control as they are data points which are potentially sensitive and subject 
+# to change depending on the environment.
+*.tfvars
+*.tfvars.json
+
+# Ignore override files as they are usually used to override resources locally and so
+# are not checked in
+override.tf
+override.tf.json
+*_override.tf
+*_override.tf.json
+
+# Ignore transient lock info files created by terraform apply
+.terraform.tfstate.lock.info
+
+# Include override files you do wish to add to version control using negated pattern
+# !example_override.tf
+
+# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
+# example: *tfplan*
+
+# Ignore CLI configuration files
+.terraformrc
+terraform.rc
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# vitepress build output
+**/.vitepress/dist
+
+# vitepress cache directory
+**/.vitepress/cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

CODE_OF_CONDUCT.md

@@ -0,0 +1,5 @@
+# Permit CLI Community Code of Conduct
+Permit CLI follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting
+the maintainers via <conduct@permit.io>.

CONTRIBUTING.md

@@ -0,0 +1,81 @@
+# Contributing Guide
+
+We would love for you to contribute to this project and help make it even better than it is today! 💎
+
+As a contributor, here are the guidelines we would like you to follow:
+ - [New Commands Guidelines](#new-command-guidelines)
+ - [Code of Conduct](https://github.com/permitio/permit-cli/blob/master/CODE_OF_CONDUCT.md)
+ - [Question or Problem?](#question)
+ - [Issues and Bugs](#issue)
+ - [Feature Requests](#feature)
+
+
+
+## New Command Guidelines
+
+We are excited to have you onboard as a contributor to Permit CLI! 🎉
+
+For new commands, we have a few guidelines to ensure consistency and maintainability:
+
+
+## <a name="question"></a> Got a Question or Problem?
+Come talk to us about Permit CLI, or authorization in general - we would love to hear from you ❤️
+
+You can:
+- Raise questions in our [GitHub discussions](https://github.com/permitio/permit-cli/discussions)
+- Report issues and ask for features in [GitHub issues](https://github.com/permitio/permit-cli/issues)
+- Follow us on [Twitter](https://twitter.com/permit_io) to get the latest Permit CLI updates
+- Join our [Slack community](https://io.permit.io/slack) to chat about authorization, open-source, realtime communication, tech or anything else! We are super available on Slack ;)
+
+If you are using our project, please consider giving us a ⭐️
+
+### <a name="issue"></a> Found a Bug?
+If you find a bug in the source code, you can help us by [submitting an issue](https://github.com/permitio/permit-cli/issues) or even better, you can [submit a Pull Request](#submit-pr) with a fix.
+
+Before you submit an issue, please search the issue tracker; maybe an issue for your problem already exists, and the discussion might inform you of workarounds readily available.
+
+We want to fix all the issues as soon as possible, but before fixing a bug, we need to reproduce and confirm it.
+In order to reproduce bugs, we require that you provide a full loom or other kind of terminal recording, so we can understand the issue and reproduce it.
+
+### <a name="feature"></a> Missing a Command / Feature?
+You can *request* a new feature by [submitting an issue](https://github.com/permitio/permit-cli/issues) to our GitHub Repository.
+Please provide as much detail and context as possible, along with examples or references to similar features, as this will help us understand your request better.
+
+We encourage you to contribute to Permit CLI by submitting a [Pull Request](#submit-pr) with your feature implementation and are happy to guide you through the process.
+
+We are always looking to improve Permit CLI and would love to hear your ideas!
+
+### <a name="submit-pr"></a> Submitting a Pull Request (PR)
+
+Pull requests are welcome! 🙏
+
+Please follow these guidelines:
+
+1. **Create an Issue**: Open a [GitHub Issue](https://github.com/permitio/permit-cli/issues) for your feature or bug fix.
+2. **Fork & Branch**: Fork this repository and create a new branch based on `main`. Name your branch descriptively (e.g., `fix/issue-123`, `feature/new-fetch-provider`).
+3. **Write Tests**: If your changes affect functionality, include tests.
+4. **Update Documentation**: Ensure any new features or configurations are documented.
+5. **Check Quality**: Run all tests and linters:
+    ```bash
+    npm run lint
+    npm run test
+    ```
+6. **Submit PR**: Open a pull request, linking to the issue and explaining your changes clearly.
+
+We aim to review all PRs promptly. After you submit a PR, here’s what you can expect:
+1. **Initial Review:** A maintainer will review your PR within a few days. If there are any issues, they will provide feedback.
+2. **Feedback:** If changes are needed, please make the necessary updates and push them to your branch. The PR will be updated automatically.
+3. **Approval:** Once your PR is approved, it will be merged into the main branch.
+4. **Release:** Your changes will be included in the next release of Permit CLI. We will update the changelog and release notes accordingly.
+5. **Announcement:** We will announce your contribution in our community channels and give you a shoutout! 🎉
+
+### Contributor Checklist
+
+Before submitting your contribution, ensure the following:
+
+- [ ] Issue created and linked in the PR
+- [ ] Branch created from `main` and appropriately named
+- [ ] Tests written and passing
+- [ ] Documentation updated (if applicable)
+- [ ] Code formatted and linted
+- [ ] Changes thoroughly explained in the PR description