Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/StackExchange/Stacks

Stack Overflow’s Design System
https://github.com/StackExchange/Stacks

Last synced: 3 months ago
JSON representation

Stack Overflow’s Design System

Awesome Lists containing this project

README 

        
# Stacks



[![ci status][gh-action-badge]][gh-action-url] [![npm version][npm-badge]][npm-url]



Stacks is Stack Overflow’s design system. It includes the resources needed to create consistent, predictable interfaces and workflows that conform to Stack Overflow’s principles, design language, and best practices.



Our documentation is built with Stacks itself, using its [immutable, atomic classes](http://johnpolacek.com/rethinking/) and components.



The Stacks website documents:



### Product

- Semantic and accessible component markup

- Cross-browser compatible Less / CSS

- An [icon library](https://github.com/StackExchange/Stacks-Icons)



### Email

- Email templates & components



Stacks documentation can be found at https://stackoverflow.design/



## Table of contents



- [Using Stacks](#using-stacks)

- [Migrating from v1 to v2](#migrating-from-v1-to-v2)

- [Building Stacks](#building-stacks)

- [Format Stacks](#format-stacks)

- [Linting Stacks](#linting-stacks)

- [Testing Stacks](#testing-stacks)

- [Releasing Stacks](#releasing-a-new-version-of-stacks)

- [Bugs and feature requests](#bugs-and-feature-requests)

- [Contributing](#contributing)

- [License](#license)



## Using Stacks

Using Stacks is outlined in our [usage guidelines](https://stackoverflow.design/product/develop/using-stacks).



## Migrating from v1 to v2



To migrate from Stacks v1 to v2, see our [migration guide](/MIGRATION_GUIDE.md).



## Building Stacks

To contribute to Stacks documentation or its CSS library, you’ll need to build Stacks locally. View our [building guidelines](https://stackoverflow.design/product/develop/building).



Having trouble getting these steps to work? Open [an issue](https://github.com/StackExchange/Stacks/issues/new) with a `setup` label.



## Format Stacks



Format the source code with prettier via running:

```sh

npm run format

```



## Linting Stacks



Run all lint suites by running:

```sh

npm run lint

```



Lint the styles (stylelint) by running:

```sh

npm run lint:css

```

Lint the typescript source code (eslint) via running:

```sh

npm run lint:ts

```

Lint the source code format (prettier) via running:

```sh

npm run lint:format

```



## Testing Stacks



Run all test suites by running:

```sh

npm test

```

### Unit/Component Tests



Unit/Component tests are written with [DOM Testing Library](https://testing-library.com/docs/dom-testing-library/intro).

Please follow the library's principles and documentation to write tests.



Stacks uses [Web Test Runner](https://modern-web.dev/docs/test-runner/overview/) and [Playwright](https://modern-web.dev/docs/test-runner/browser-launchers/playwright/) to run tests in a real browser context.



Execute the unit/component tests suite by running:

```sh

npm run test:unit

```

or if you prefer watch mode run:

```sh

npm run test:unit:watch

```



### Visual Regression Tests



**Prerequisites:** 

- `git lfs` ([installation docs](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage))

- `docker` ([installation docs](https://docs.docker.com/engine/install/))

- `pwsh` ([Installation docs](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.3))

- Run `git config diff.lfs.textconv cat` to make sure image diff works as expected ([More info](https://github.com/microsoft/vscode/issues/86611#issuecomment-875894108))



This [Web Test Runner plugin](https://www.npmjs.com/package/@web/test-runner-visual-regression) is used to run visual regression tests.

Visual regression tests end with this suffix `*.visual.test.ts`.



Execute the visual regression tests suite by running:

```sh

npm run test:visual

```

After the first run, if there are failing snapshots, they end up overriding the baseline ones in the filesystem (e.g. `/screenshots//baseline/.png`). 

We do this for easier comparison of the dif directly in vscode and to make sure only the failing snapshots get regenerated (see [this GH discussion](https://github.com/modernweb-dev/web/discussions/427#discussioncomment-3543771) that inspired the approach).



We also recommend to install [this vscode extension](https://marketplace.visualstudio.com/items?itemName=RayWiis.png-image-diff) for getting better diffs.



### Less Tests



This is an experimental suite to test the generation of CSS from Less files. 

Less tests end with this suffix `*.less.test.ts`.



Execute the less tests suite by running:

```sh

npm run test:less

```



Update the css snapshots via:

```sh

npm run test:less:update

```



## Releasing a new version of Stacks

Stacks uses [Semantic Versioning](https://semver.org/), is distributed via [npm](https://www.npmjs.com/package/@stackoverflow/stacks), and publishes [release notes on Github](https://github.com/StackExchange/Stacks/releases). Follow the steps below to release a new version of Stacks.



### Bump the version number

```sh

npm version [major | minor | patch]

```



### Push the new tag

```sh

git push && git push --tags

```



### Create release notes [on Github](https://github.com/StackExchange/Stacks/releases/new)



1. Visit https://github.com/StackExchange/Stacks/releases/new

1. Choose your new version from the "Choose a tag" dropdown

1. Click "Generate release notes"

1. Cleanup and complete the release notes

    - Prominently mention any breaking changes, if applicable

    - Include a "What's Changed" section in the release notes

    - Mention significant bug fixes

    - Mention new features

    - Mention significant under-the-hood changes that could impact consumers



### Ship your newly created version to [npm](https://www.npmjs.com/package/@stackoverflow/stacks)

```sh

npm publish

```



### Merge `develop` into `production` and push

```sh

git checkout production && git merge develop && git push

```



### Push the updated docs site

Head to [Netlify](https://app.netlify.com), navigate to the Stacks overview, click on "Production deploys", and select "Deploy site" from the "Trigger deploy" dropdown.



## Bugs and feature requests

Have a bug or feature request? First search existing or closed issues to make sure the issue hasn’t been noted yet. If not, review our [issue guidelines](/CONTRIBUTING.md#open-an-issue) for submitting [a bug report](/CONTRIBUTING.md#reporting-bugs) or [feature request](/CONTRIBUTING.md#feature-requests).



## Contributing

If you’d like to contribute to Stacks, please read through our [contribution guidelines](/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.



## License

Code and documentation copyright 2017-2024 Stack Exchange, Inc and released under the [MIT License](/LICENSE.MD).



[gh-action-url]: https://github.com/StackExchange/Stacks/actions/workflows/main.yml

[gh-action-badge]: https://github.com/StackExchange/Stacks/actions/workflows/workflow.yml/badge.svg?branch=develop

[npm-url]: https://npmjs.org/package/@stackoverflow/stacks

[npm-badge]: https://img.shields.io/npm/v/@stackoverflow/stacks.svg