README.md

Stellar Elements

A small design system for Stellar.org user interfaces using styleguidist.

Contributing

Developing

Code examples in Markdown use ES6+JSX syntax. You can use the current component without explicitly importing it:

// ```jsx inside Button/Readme.md or Button.md
<Button>Push Me</Button>

To use other components, you need to explicity import them. Reference on Writing code examples on styleguidist

// ```jsx inside Panel/Readme.md or Panel.md
import { all } from 'dog-names';
import { RandomButton } from '../RandomButton';
<RandomButton variants={all} />

Merging in changes

Make a pull request if you want to contribute changes to the library. Make sure all tests pass! An @stellar employee will merge your PR into master if all looks okay.

Releasing

Before releasing, make a pull request changing the version number in package.json to the version you're planning to release.

Once the library is ready for release, make a new release tag. CircleCI will automatically publish changes to NPM when it sees new releases starting with v.