Small contribution spec
The following page outlines the process of a light contribution to CivicTheme.
Component overview
Component name
[Insert Component Name]
Type
[Atom, Molecule, Organism, etc.]
Intended purpose
Short description of the purpose of the component (e.g., "To ensure proper alignment of text in mobile views.")
Primary use case
[Describe the primary scenario where this component is used.]
Secondary use case
[Optional, additional scenarios where it could be applied.]
Existing patterns/components
Do any existing patterns fulfill this need?
[Yes/No. If yes, reference the relevant pattern.]
Interactions and behaviours
Intended user interactions
[Describe basic interactions (e.g., "Button click changes state.")]
Expected component behaviour
[Define behaviour under different conditions (e.g., responsive behaviour, error states).]
Accessibility considerations
WCAG compliance level
[A, AA]
Expected component behaviour (accessibility)
[Describe basic accessibility considerations.]
Potential accessibility challenges
[List any accessibility risks, or "None."]
User research
Research completed
[Optional. Include if any user research has been done.]
Results
[Summarise results briefly if available.]
Security requirements
Security considerations
[Describe any minor security concerns if applicable.]
Data handling requirements
[Describe handling of sensitive data, or "None."]
Privacy concerns
[Any privacy issues, or "None."]
Submission details
Submitted by
[Contributor's Name]
Date
[Submission Date]
Contact information
[Name, Email or GitHub username]
Feedback
We're always looking at ways to improve our model for contributions, and rely on your feedback to ensure an enjoyable contribution experience. The best way to give us feedback is to join our Slack channel and chat to us there, or contact us via email!
Last updated