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.

Sign up for GitHub

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

Jump to bottom

chore: README for each sub package #274

Merged
merged 1 commit into from
Jun 20, 2024
Merged

chore: README for each sub package #274

merged 1 commit into from
Jun 20, 2024

Conversation

d-jeffery
Copy link
Contributor

Description

References

Review Checklist

  • I have clicked on "allow edits by maintainers".
  • I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
  • The correct base branch is being used, if not main
  • I have added tests to validate that the change in functionality is working as expected

@d-jeffery d-jeffery force-pushed the chore/readme-cleanup branch from 7600f28 to bd25928 Compare June 14, 2024 21:32
rhamzeh
rhamzeh requested changes Jun 15, 2024
View reviewed changes
Copy link
Member

@rhamzeh rhamzeh left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the re-org :)

While you're working on this, can you also change package.json to remove the README parts?

    "prepublishOnly": "npm run build && cp ../../LICENSE .",
    "postpublish": "rm -f  LICENSE",

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
pkg/js/README.md Outdated Show resolved Hide resolved
@d-jeffery d-jeffery force-pushed the chore/readme-cleanup branch 4 times, most recently from ef998cf to cfe284f Compare June 18, 2024 20:51
@d-jeffery d-jeffery marked this pull request as ready for review June 18, 2024 20:53
@d-jeffery d-jeffery requested review from a team as code owners June 18, 2024 20:53
@d-jeffery d-jeffery requested a review from rhamzeh June 18, 2024 20:53
rhamzeh
rhamzeh reviewed Jun 19, 2024
View reviewed changes
pkg/js/README.md Outdated Show resolved Hide resolved
@d-jeffery d-jeffery force-pushed the chore/readme-cleanup branch from cfe284f to c86a21f Compare June 20, 2024 13:24
@d-jeffery d-jeffery requested a review from rhamzeh June 20, 2024 13:43
rhamzeh
rhamzeh reviewed Jun 20, 2024
View reviewed changes
Copy link
Member

@rhamzeh rhamzeh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So sorry - one last minor thing. I noticed all the licenses point to the CLI, can we change that to language?

That and we're good to merge

@d-jeffery d-jeffery force-pushed the chore/readme-cleanup branch from c86a21f to 56eb87d Compare June 20, 2024 14:22
@d-jeffery d-jeffery requested a review from rhamzeh June 20, 2024 14:29
@d-jeffery d-jeffery force-pushed the chore/readme-cleanup branch from 56eb87d to 999dafe Compare June 20, 2024 14:51
@rhamzeh rhamzeh added this pull request to the merge queue Jun 20, 2024
Merged via the queue into main with commit 70a0d09 Jun 20, 2024
18 checks passed
@rhamzeh rhamzeh deleted the chore/readme-cleanup branch June 20, 2024 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rhamzeh rhamzeh rhamzeh approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@d-jeffery @rhamzeh