CivicTheme
  • Docs
  • Changelog
  • Getting started
    • Introduction
    • Installation
    • Getting help
    • Security policy
    • Partnerships
  • Installation
    • Drupal theme
  • Contributing
    • Contribution model
    • Contribution basics
    • Small contribution spec
    • Medium contribution spec
    • Major (RFC-level) contribution spec
    • Code of conduct
    • Figma contributions
  • Components
    • Component list
  • Content Authoring
    • Overview
    • Global settings
      • Favicon
      • Header
        • Site slogan
        • Header logos
        • Primary navigation
        • Secondary navigation
      • Banner
      • Search
      • Link
      • Skip link
      • Side navigation
      • Signup
      • Footer
        • Footer logo
        • Social links
        • Footer navigation
        • Acknowledgement of Country
        • Copyright
      • Colours
    • Content types
      • Page
        • Configure the banner
      • Event
      • Alert
    • Content components
      • Accordion
      • Automated list
      • Attachment
      • Callout
      • Campaign
      • Content
        • Quote
      • iFrame
      • Manual List
        • Event card
        • Event reference card
        • Navigation card
        • Navigation reference card
        • Promo card
        • Promo reference card
        • Publication card
        • Service card
        • Subject card
        • Subject reference card
        • Snippet
      • Map
      • Next step
      • Promo
      • Slider
      • Webform
    • Vocabularies
      • Topics
      • Site sections
    • User accounts & roles
Powered by GitBook
On this page
  • Component overview
  • Existing patterns/components
  • Interactions and behaviours
  • Accessibility considerations
  • User research
  • Security requirements
  • Submission details
  • Feedback

Was this helpful?

Edit on GitHub
Export as PDF
  1. Contributing

Small contribution spec

The following page outlines the process of a light contribution to CivicTheme.

Component overview

Field
Description

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

Field
Description

Do any existing patterns fulfill this need?

[Yes/No. If yes, reference the relevant pattern.]

Interactions and behaviours

Field
Description

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

Field
Description

WCAG compliance level

[A, AA]

Expected component behaviour (accessibility)

[Describe basic accessibility considerations.]

Potential accessibility challenges

[List any accessibility risks, or "None."]

User research

Field
Description

Research completed

[Optional. Include if any user research has been done.]

Results

[Summarise results briefly if available.]

Security requirements

Field
Description

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

Field
Description

Submitted by

[Contributor's nName]

Date

[Submission date]

Contact information

[Name, Email or GitHub username]


Feedback

PreviousContribution basicsNextMedium contribution spec

Last updated 4 months ago

Was this helpful?

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 and chat to us there, or contact us via !

Slack channel
email