Skip to content

Commit c0bcd01

Browse files
committed
init
0 parents  commit c0bcd01

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+16265
-0
lines changed

.github/workflows/cla.yaml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: "CLA Assistant"
3+
on:
4+
issue_comment:
5+
types:
6+
- "created"
7+
pull_request_target:
8+
types:
9+
- "opened"
10+
- "closed"
11+
- "synchronize"
12+
13+
jobs:
14+
CLAssistant:
15+
runs-on: "ubuntu-latest"
16+
steps:
17+
- name: "CLA Assistant"
18+
if: "(github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'"
19+
uses: "cla-assistant/[email protected]"
20+
env:
21+
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
22+
PERSONAL_ACCESS_TOKEN: "${{ secrets.CLA_ASSISTANT_ACCESS_TOKEN }}"
23+
with:
24+
remote-organization-name: "authzed"
25+
remote-repository-name: "cla"
26+
path-to-signatures: "v1/signatures.json"
27+
path-to-document: "https://github.com/authzed/cla/blob/main/v1/icla.md"
28+
branch: "main"
29+
allowlist: "authzedbot,dependabot-bot"

.github/workflows/lint.yaml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: "Lint"
3+
on:
4+
push:
5+
branches:
6+
- "main"
7+
pull_request:
8+
branches:
9+
- "*"
10+
jobs:
11+
lint:
12+
name: "Lint Everything"
13+
runs-on: "ubuntu-latest"
14+
steps:
15+
- uses: "actions/checkout@v2"
16+
- uses: "bewuethr/[email protected]"
17+
with:
18+
config-file: ".yamllint"
19+
- uses: "nosborn/[email protected]"
20+
with:
21+
files: "."
22+
config_file: ".markdownlint.yaml"

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.docusaurus/*
2+
build/*
3+
node_modules/*

.markdownlint.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
line-length: false
3+
no-hard-tabs: false

.yamllint

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# vim: ft=yaml
2+
---
3+
yaml-files:
4+
- "*.yaml"
5+
- "*.yml"
6+
- ".yamllint"
7+
extends: "default"
8+
rules:
9+
quoted-strings: "enable"
10+
line-length: "disable"

CODE-OF-CONDUCT.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Code of Conduct
2+
3+
As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4+
5+
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
6+
7+
Examples of unacceptable behavior by participants include:
8+
9+
- The use of sexualized language or imagery
10+
- Personal attacks
11+
- Trolling or insulting/derogatory comments
12+
- Public or private harassment
13+
- Publishing other’s private information, such as physical or electronic addresses, without explicit permission
14+
- Other unethical or unprofessional conduct
15+
16+
Project maintainers 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.
17+
By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project.
18+
Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
19+
20+
This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
21+
22+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
23+
24+
This Code of Conduct is adapted from the Contributor Covenant, version 1.2.0, available [here](https://www.contributor-covenant.org/version/1/2/0/code-of-conduct.html)

CONTRIBUTING.md

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# How to contribute
2+
3+
## Communication
4+
5+
- Issues: [GitHub](https://github.com/authzed/docs/issues)
6+
- Email: [Google Groups](https://groups.google.com/g/authzed-oss)
7+
- Discord: [Zanzibar Discord](https://authzed.com/discord)
8+
9+
All communication must follow our [Code of Conduct].
10+
11+
[Code of Conduct]: CODE-OF-CONDUCT.md
12+
13+
## Creating issues
14+
15+
If any part of the project has a bug or documentation mistakes, please let us know by opening an issue.
16+
All bugs and mistakes are considered very seriously, regardless of complexity.
17+
18+
Before creating an issue, please check that an issue reporting the same problem does not already exist.
19+
To make the issue accurate and easy to understand, please try to create issues that are:
20+
21+
- Unique -- do not duplicate existing bug report.
22+
Duplicate bug reports will be closed.
23+
- Specific -- include as much details as possible: which version, what environment, what configuration, etc.
24+
- Reproducible -- include the steps to reproduce the problem.
25+
Some issues might be hard to reproduce, so please do your best to include the steps that might lead to the problem.
26+
- Isolated -- try to isolate and reproduce the bug with minimum dependencies.
27+
It would significantly slow down the speed to fix a bug if too many dependencies are involved in a bug report.
28+
Debugging external systems that rely on this project is out of scope, but guidance or help using the project itself is fine.
29+
- Scoped -- one bug per report.
30+
Do not follow up with another bug inside one report.
31+
32+
It may be worthwhile to read [Elika Etemad’s article on filing good bug reports][filing-good-bugs] before creating a bug report.
33+
34+
Maintainers might ask for further information to resolve an issue.
35+
36+
[filing-good-bugs]: http://fantasai.inkedblade.net/style/talks/filing-good-bugs/
37+
38+
## Contribution flow
39+
40+
This is a rough outline of what a contributor's workflow looks like:
41+
42+
- Create an issue
43+
- Fork the project
44+
- Create a [feature branch]
45+
- Push changes to your branch
46+
- Submit a pull request
47+
- Respond to feedback from project maintainers
48+
49+
Creating new issues is one of the best ways to contribute.
50+
You have no obligation to offer a solution or code to fix an issue that you open.
51+
If you do decide to try and contribute something, please submit an issue first so that a discussion can occur to avoid any wasted efforts.
52+
53+
[feature branch]: https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow
54+
55+
## Legal requirements
56+
57+
In order to protect both you and ourselves, all commits will require an explicit sign-off that acknowledges the [DCO].
58+
59+
Sign-off commits end with the following line:
60+
61+
```git
62+
Signed-off-by: Random J Developer <[email protected]>
63+
```
64+
65+
This can be done by using the `--signoff` (or `-s` for short) git flag to append this automatically to your commit message.
66+
If you have already authored a commit that is missing the signed-off, you can amend or rebase your commits and force push them to GitHub.
67+
68+
[DCO]: /DCO

DCO

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
Developer Certificate of Origin
2+
Version 1.1
3+
4+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
5+
1 Letterman Drive
6+
Suite D4700
7+
San Francisco, CA, 94129
8+
9+
Everyone is permitted to copy and distribute verbatim copies of this
10+
license document, but changing it is not allowed.
11+
12+
13+
Developer's Certificate of Origin 1.1
14+
15+
By making a contribution to this project, I certify that:
16+
17+
(a) The contribution was created in whole or in part by me and I
18+
have the right to submit it under the open source license
19+
indicated in the file; or
20+
21+
(b) The contribution is based upon previous work that, to the best
22+
of my knowledge, is covered under an appropriate open source
23+
license and I have the right under that license to submit that
24+
work with modifications, whether created in whole or in part
25+
by me, under the same open source license (unless I am
26+
permitted to submit under a different license), as indicated
27+
in the file; or
28+
29+
(c) The contribution was provided directly to me by some other
30+
person who certified (a), (b) or (c) and I have not modified
31+
it.
32+
33+
(d) I understand and agree that this project and the contribution
34+
are public and that a record of the contribution (including all
35+
personal information I submit with it, including my sign-off) is
36+
maintained indefinitely and may be redistributed consistent with
37+
this project or the open source license(s) involved.

0 commit comments

Comments
 (0)