openfga / openfga/model-visualizer
Prepare to make the repo public
Open
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
Here's a few things we need to do before we are ready to make this repo public. Some of these we can only do post-opening up (e.g. EasyCLA).
- Add
.github/CODEOWNERfile, it can be:* @openfga/backend - Update README
- Match the templates we use for OpenFGA (we can use the CLI or SDKs as a template): e.g. About (Key Features), Installation, Getting Started, Examples, Contributing, License
- Add note regarding the licensing and linking to the license
- Security and Licensing
- Set the license to Apache-2.0, as preferred by CNCF
- Configure Snyk
- Ensure no security violations are found
- Configure dependabot
- Configure FOSSA
- Ensure no license violations are found
- Setup EasyCLA (can only be done by @aaguiarz after the repo is public)
- Admin
- Set branch protection for main
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the README and existing .github/CODEOWNER file first, then inspect the remaining unchecked security and dependency-management tasks in the issue. Confirm the README follows the requested OpenFGA structure and that the listed Snyk, dependabot, and EasyCLA work is either completed or explicitly deferred as described.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- devops, documentation, release, security
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100