Consider clarifying which RFCs are supported
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 75/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- php
- Domain
- documentation
Research direction
The issue points to README.md and composer.json files. Start by reading these files to understand the current wording about RFC 7519. Then, look for any existing mentions of JWS (RFC 7515) and JWE (RFC 7516) in the documentation or code comments. The goal is to clarify that the library supports JWT payloads inside a JWS structure but does not support JWE. Edit the README.md and composer.json to explicitly state this, ensuring consistency. Check if there are any example files that might also need updating to avoid confusion.
Written by the indexing model from the issue text.
Description
Hello!
In the README.md and composer.json the project somewhat vaguely states it's a JWT library that conforms to RFC 7519. To be precise, the project only supports JWT payloads inside a JWS structure (RFC 7515) and there is no support for it's encrypted sibling, the JWE (RFC 7516).
Explicitly stating this would be time saving, because it is not fully clear from the provided examples either. This should also save time from the maintainers, because inquiries such as https://github.com/firebase/php-jwt/issues/359 should go away.
- Dominant language
- PHP
- Stars
- 1.2k
- Forks
- 464
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 103
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.
More from googleapis/google-cloud-php
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
googleapis/google-cloud-php#9730 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 65/100
googleapis/google-cloud-php#9725 ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
googleapis/google-cloud-php#9675 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
googleapis/google-cloud-php#9674 · 1 comment ·
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
googleapis/google-cloud-php#9503 ·
All issues in googleapis/google-cloud-php
Similar issues
-
tooling
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
UX
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
ProfessionalWiki/NeoWiki#1525 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
OpenConext/OpenConext-engineblock#2122 ·
-
Bug
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Automattic/safe-publish#594 ·