ml-opensource / ml-opensource/API-manifesto
Topic: "X-" or "X-COMPANY-" prefix for custom headers
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 10
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
Based on this SO answer I think it might be a good idea to recommend (but not enforce) using the X- or X-COMPANY- prefix in custom header names.
This would help distinguish them from standard headers.
Contributor guide
No contributing guide indexed for this repository
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
Start by reading the linked Stack Overflow answer and the existing API manifesto guidance on custom headers. Review the ten-comment discussion before deciding whether the recommendation is settled. Done means the manifesto clearly documents the agreed guidance without making the prefix mandatory.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100