📝 Contribution Guidelines
Clear documentation standards for submitting and maintaining entries in our collaborative cookie knowledge base.
🌟 Our Principles
-
1
Technical Accuracy
All contributions must be technically sound, referencing official specifications (RFC 6265) and current browser standards. Avoid speculative or unverified claims.
-
2
Neutral Tone
Use objective language without personal opinions or subjective advice. Maintain a professional tone that respects diverse technical backgrounds.
-
3
Accessibility
Ensure documentation is clear for both novice and experienced developers by defining acronyms on first use and avoiding unnecessary jargon.
-
4
Security First
All examples must demonstrate secure cookie practices using
HttpOnly
,Secure
, and properSameSite
attributes by default.
✍️ Formatting Standards
Markdown Syntax
- • Use
###
for section headers - • List technical terms in
monospace
format - • Include practical code snippets with
javascript
tags - • Add working examples where possible with
live
flags - • Use 4-space indentation for code blocks
Visual Aids
- • Include SVG-based flowcharts for complex operations
- • Add browser compatibility tables for new features
- • Provide before/after comparisons for optimization techniques
- • Use 3-color gradients for key terminology highlights
- • Keep diagrams under 500x500 pixels for readability
✅ Review Process
All contributions go through a two-stage review: first by our team of volunteer reviewers, then by core maintainers for final approval.
1. Submit Draft
Create a pull request or use our collaborative editor
2. Initial Review
Community reviewers check for technical accuracy
3. Final Approval
Lead maintainers merge to production
📚 Citation Requirements
RFC Compliance
document.cookie
behavior must reference relevant RFC 6265 sections. Include specific chapter/article links where appropriate.
Browser Support
For any feature-specific note, provide official Chromium, Gecko, or Webkit documentation sources.
Security References
Security best practices should be linked to OWASP guidelines or NIST recommendations.
Historical Context
When describing obsolete cookie practices, cite the replacement standards.