Skip to content

Latest commit

 

History

History
47 lines (28 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

47 lines (28 loc) · 2.32 KB
Raw

Contributing

Thank you for wanting to contribute.

To help out, you can:

Not only will you help helious/emotion-mirror thrive, but you may learn a thing or two — about CSS, CSS-in-JS, Emotion, Node, Rollup.js, Stylelint, unit testing, open-source software, and more. We want to encourage contributions! If you want to participate but couldn't, please give us feedback about what we could do better.

Code contributions

To start coding, you'll need the:

Then:

  1. Fork and clone the helious/emotion-mirror repository.
  2. Install all the dependencies with npm ci.
  3. Run npm start to start up Rollup and start the web server.
  4. You will be able to view App.tsx at http://localhost:8080/

Write code

With the interactive testing prompt running, you can write code confident that things are working as expected.

  • App.tsx - the React app that is running on http://localhost:8080/
  • src/ - contains the styled wrapper and stylelint integration

Run tests

Next, you'll want to run the tests using npm test and make sure they all pass. Make sure to adjust or add tests based on changes in functionality. We currently use jest and react-testing-library for unit tests.

Format code

We use Prettier to format code.

Open a pull request

When you have something to share, it's time to open a pull request.

After we review and merge your pull request, I'll invite you to become a maintainer of the helious/emotion-mirror repository. You'll then be able to help manage issues, pull requests and releases. You'll also be able to work on the helious/emotion-mirror repository rather than your fork.