Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README and CONTRIBUTING #329

Merged
merged 1 commit into from
Jun 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Prior to submitting any PRs, please review and familiarize yourself with the fol
- If you find a bug or have a feature request, please [open an issue](https://github.com/warrant-dev/warrant/issues/new/choose). In order to prevent duplicate reports, please first search through existing open issues for your request prior to creating a new one.
- If you discover a security issue or vulnerability, do not create an issue. Please email us with details at security@warrant.dev.
- If you find small mistakes or issues in docs/instructions etc., feel free to submit PR fixes without first creating issues.
- If you'd like to contribute a fix or implementation for an issue, please first consult with a member of the Warrant team on your approach, either directly on the issue via comments or on [Slack](https://join.slack.com/t/warrantcommunity/shared_invite/zt-12g84updv-5l1pktJf2bI5WIKN4_~f4w).
- If you'd like to contribute a fix or implementation for an issue, please first consult on your approach with a member of the Warrant team directly on the GitHub issue.
- [Here](https://github.com/warrant-dev/warrant/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) is a list of 'good first issues' for new contributors.

## Making changes
Expand All @@ -26,7 +26,3 @@ Prior to submitting any PRs, please review and familiarize yourself with the fol
- Pull requests will trigger ci jobs that run linters, static analysis and tests. It is the submitter's responsibility to ensure that all ci checks are passing.
- A member of the Warrant team will review your PR. Once approved, you may merge your PR into main.
- New versions will be tagged and released automatically.

## Getting help

If at any point you need help, please reach out to the Warrant team via [Slack](https://join.slack.com/t/warrantcommunity/shared_invite/zt-12g84updv-5l1pktJf2bI5WIKN4_~f4w).
5 changes: 0 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
<img alt="GitHub" src="https://img.shields.io/github/license/warrant-dev/warrant?color=4F0DCC">
<img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/warrant-dev/warrant?color=FF5E00">
<img alt="GitHub Workflow Status (with branch)" src="https://img.shields.io/github/actions/workflow/status/warrant-dev/warrant/go.yaml?branch=main">
<a href="https://join.slack.com/t/warrantcommunity/shared_invite/zt-12g84updv-5l1pktJf2bI5WIKN4_~f4w"><img alt="Slack Community" src="https://img.shields.io/badge/Slack%20Community-4A154B?style=flat&logo=slack"></a>
<a href="https://twitter.com/warrant_dev"><img alt="Twitter Follow" src="https://img.shields.io/badge/follow-%40warrant__dev-1DA1F2?logo=twitter"></a>
<a href="https://www.ycombinator.com/companies/warrant"><img alt="Backed by Y Combinator" src="https://img.shields.io/badge/Backed%20by-Y%20Combinator-%23E16E38"/></a>
</p>
Expand Down Expand Up @@ -67,10 +66,6 @@ Warrant's native SDKs are compatible with both the cloud and open-source version

Visit our [docs](https://docs.warrant.dev/) to learn more about Warrant's key concepts & architecture and view our [quickstarts](https://docs.warrant.dev/quickstart/role-based-access-control/) & [API reference](https://docs.warrant.dev/objecttypes/get-all-object-types/).

### Support

Join our [Slack community](https://join.slack.com/t/warrantcommunity/shared_invite/zt-12g84updv-5l1pktJf2bI5WIKN4_~f4w) to ask questions and get support.

## Limitations

Serving check and query requests with low latency at high throughput requires running Warrant as a distributed service with the use of [Warrant-Tokens](https://docs.warrant.dev/data-consistency/) (also referred to as [Zookies](https://blog.warrant.dev/why-zanzibar-shines-at-building-authorization/#global-scale-low-latency) in Google Zanzibar). As a result, this open source version of Warrant is only capable of handling low-to-moderate throughput and is best suited for POCs, development/test environments, and low throughput use-cases.
Expand Down
Loading