CONTRIBUTING.md 2.3 KB
Newer Older
P
Phil Plueckthun 已提交
1 2 3 4
Thanks for giving this a read! We're always open to your contributions to styled-components.
This document will get you started on how to contribute and things you should know.
So please give it a thorough read.

P
Phil Plueckthun 已提交
5 6
Please also give the code of conduct a read.

P
Phil Plueckthun 已提交
7 8 9 10 11 12
## How do I contribute code?

1. Find some issue you're interested in, or a feature that you'd like to tackle.
  Also make sure that no one else is already working on it. We don't want you to be
  disappointed.

13
2. Fork, then clone: `git clone https://github.com/YOUR_USERNAME/styled-components.git`
P
Phil Plueckthun 已提交
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

3. Create a branch with a meaningful name for the issue: `git checkout -b fix-something`

4. Make your changes and commit: `git add` and `git commit`

5. Make sure that the tests still pass: `npm test` and `npm run flow` (for the type checks)

6. Push your branch: `git push -u origin your-branch-name`

7. Submit a pull request to the upstream styled-components repository.

8. Choose a descriptive title and describe your changes briefly.

9. Wait for a maintainer to review your PR, make changes if it's being recommended, and get it merged.

10. Perform a celebratory dance! :dancer:

## How do I set up the project?

33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
To make development process easier, you could use a sandbox provided in this repo.

- First, run `npm install`. This will install all project dependencies.

- Then, run `npm run dev`. This will start `webpack-dev-server` and you will be able to access the sandbox on `localhost:8080`.

In the sandbox `styled-components` is an alias to `./src` folder, so you can edit the source directly and dev-server will handle 
rebuilding the source and reloading youur sandbox.

You can use an interactive editor, powered by [`react-live`](https://react-live.philpl.com/), to test your changes. But if you want more control,
you can edit the sandbox itseft. Entry point for the sandbox is located at `./sandbox/index.js`

As this is just a `webpack-dev-server`, you could use its flags to change port or automatically open sandbox 
in browser on start; e.g. `npm run dev -- --open` will automatically open sandbox in browser. [More info about 
`webpack-dev-server` flags](https://webpack.js.org/configuration/dev-server/)
P
Phil Plueckthun 已提交
48 49 50 51

When you commit our pre-commit hook will run, which executes `lint-staged`. It will run
the linter automatically and warn you, if the code you've written doesn't comply with our
code style.