You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
wip
Add gitignore and edit rollup config
Update gitignore
Wip
WIP
Get rid of older json files and use js files to extend across pkgs later
Make test:native work again, thanks to @SimenB
No haste and get integration test to work
Update husky
Update package.json
Update travis and appveyor
Add lint script
Update sandbox
Update yarn version
Move eslint into sc package
Remove unnecessary files
Update lint-staged
Update CONTRIBUTING.md
Update version in lerna.json
Update contributing
Update scripts
Update contributing
Update contributing
Update contributing.md and publish script
Update contributing
v4.1.4-alpha.0
Update package json
Update lerna version
v4.1.4-alpha.0
v4.1.4-alpha.1
Independent version for sandbox and styled-components
Yarn instead of npm
Add readme to styled-components package to show up on npm
Publish
- [email protected]
Update prepublisOnly and contributing
Update gitignore
Publish
- [email protected]
Test without readme
Remove readme
Publish
- [email protected]
Copy readme prepublishOnly
Publish
- [email protected]
Copy file name to clipboardexpand all lines: CHANGELOG.md
+2
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,8 @@ _The format is based on [Keep a Changelog](http://keepachangelog.com/) and this
8
8
9
9
- Make the `GlobalStyleComponent` created by `createGlobalStyle` call the base constructor with `props` (see [#2321](https://github.com/styled-components/styled-components/pull/2321)).
10
10
11
+
- Move to Mono repository structure with lerna [@imbhargav5](https://github.com/imbhargav5) (see [#2326](https://github.com/styled-components/styled-components/pull/2326))
12
+
11
13
## [v4.1.3] - 2018-12-17
12
14
13
15
- Under the hood code cleanup of the Babel macro, by [@lucleray](https://github.com/lucleray) (see [#2286](https://github.com/styled-components/styled-components/pull/2286))
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+30-27
Original file line number
Diff line number
Diff line change
@@ -34,9 +34,9 @@ We want contributors to provide ideas, keep the ship shipping and to take some o
34
34
35
35
The fact that you'll have push access will allow you to:
36
36
37
-
* Avoid having to fork the project if you want to submit other pull requests as you'll be able to create branches directly on the project.
38
-
* Help triage issues, merge pull requests.
39
-
* Pick up the project if other maintainers move their focus elsewhere.
37
+
- Avoid having to fork the project if you want to submit other pull requests as you'll be able to create branches directly on the project.
38
+
- Help triage issues, merge pull requests.
39
+
- Pick up the project if other maintainers move their focus elsewhere.
40
40
41
41
It's up to you to use those superpowers or not though 😉
42
42
@@ -62,47 +62,51 @@ Here is a quick guide to doing code contributions to the library.
62
62
63
63
3. Create a branch with a meaningful name for the issue: `git checkout -b fix-something`
64
64
65
-
4.Make your changes and commit: `git add` and `git commit`
65
+
4.Install packages by running `yarn` in the root of the project.
66
66
67
-
5. Make sure that the tests still pass: `npm test` and `npm run flow` (for the type checks)
67
+
5. Make your changes and commit: `git add` and `git commit`
68
68
69
-
6.Push your branch: `git push -u origin your-branch-name`
69
+
6.Make sure that the tests still pass: `yarn test` and `yarn run flow` (for the type checks)
70
70
71
-
7.Submit a pull request to the upstream styled-components repository.
71
+
7.Push your branch: `git push -u origin your-branch-name`
72
72
73
-
8.Choose a descriptive title and describe your changes briefly.
73
+
8.Submit a pull request to the upstream styled-components repository.
74
74
75
-
9.Wait for a maintainer to review your PR, make changes if it's being recommended, and get it merged.
75
+
9.Choose a descriptive title and describe your changes briefly.
76
76
77
-
10. Perform a celebratory dance! :dancer:
77
+
10. Wait for a maintainer to review your PR, make changes if it's being recommended, and get it merged.
78
+
79
+
11. Perform a celebratory dance! :dancer:
78
80
79
81
### How do I set up the project?
80
82
81
-
Run [`yarn install`](https://yarnpkg.com/) and edit code in the `src/` folder. It's luckily very simple! :wink:
83
+
Run [`yarn install`](https://yarnpkg.com/) and edit code in the `packages/styled-components/src/` folder. It's luckily very simple! :wink:
84
+
85
+
> We use yarn workspaces with [lerna](https://github.com/lerna/lerna) to make this work as a monorepo under the hood.
82
86
83
87
### How do I verify and test my changes?
84
88
85
-
To make development process easier we provide a Sandbox React application in this repo which automatically uses your local version of the `styled-components` library. That means when you make any changes in the `src/` folder they'll show up automatically there!
89
+
To make development process easier we provide a Sandbox React application in this repo which automatically uses your local version of the `styled-components` library. That means when you make any changes in the `packages/styled-components/src/` folder they'll show up automatically there!
86
90
87
91
To use the sandbox, follow these steps:
88
92
89
-
1. Go to sandbox folder: `cd sandbox`
93
+
1. Go to sandbox folder: `cd packages/sandbox`
90
94
91
-
2. Install all the dependencies: `yarn install` or `npm install`
95
+
2. Install all the dependencies: `yarn install`. Since this repository uses `yarn` workspaces, avoid using `npm` where you can.
92
96
93
-
3. Run `yarn start`or `npm start`to start sandbox server
97
+
3. Run `yarn start` to start sandbox server
94
98
95
99
Now you should have the sandbox running on `localhost:3000`. The Sandbox supports client-side and server-side rendering.
96
100
97
101
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 itself too:
98
102
99
-
* Root `<App>` component is located at `styled-components/sandbox/src/App.js` file
103
+
- Root `<App>` component is located at `packages/sandbox/src/App.js` file
100
104
101
-
* Client-side entry point is at `styled-components/sandbox/src/browser.js`
105
+
- Client-side entry point is at `packages/sandbox/src/browser.js`
102
106
103
-
* Server-side entry point is at `styled-components/sandbox/src/server.js`
107
+
- Server-side entry point is at `packages/sandbox/src/server.js`
104
108
105
-
In the sandbox source, `styled-components` is an alias to `styled-components/src` folder, so you can edit the source directly and dev-server will handle rebuilding the source and livereloading your sandbox after the build is done.
109
+
In the sandbox source, `styled-components` is an alias to `packages/styled-components/src` folder, so you can edit the source directly and dev-server will handle rebuilding the source and livereloading your sandbox after the build is done.
106
110
107
111
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 guidelines.
108
112
@@ -112,6 +116,10 @@ We have three different benchmarks: mounting a deep tree, mounting a wide tree a
112
116
113
117
To run the benchmarks run:
114
118
119
+
```sh
120
+
cd packages/styled-components`
121
+
```
122
+
115
123
```sh
116
124
yarn run benchmarks
117
125
```
@@ -139,42 +147,37 @@ a git hook is already present.
139
147
140
148
[Core team members](./CORE_TEAM.md) have the responsibility of pushing new releases to npm. The release process is as follows:
141
149
142
-
1.Install `np` by Sindre Sorhus with `npm i -g np`. (note: you only have to do this once) `np` makes sure that everything is correct and runs tests and a build before it releases the new version for you.
143
-
2.Make sure you have the latest changes and are on the master branch: `git checkout master && git pull origin master`
150
+
1. Make sure you have the latest changes and are on the master branch: `git checkout master && git pull origin master`
151
+
2. Install all the dependecies by running `yarn`in the root folder. This will also install `lerna`.
144
152
3. Create a new branch based on the version number, for example `git checkout -b 3.4.1`
145
153
4. Update the [CHANGELOG.md](./CHANGELOG.md) with the new version number, add a new Unreleased section at the top and edit the links at the bottom so everything is linked correctly
146
154
5. Commit the Changelog changes with `git commit -m 'Update CHANGELOG'`
147
155
6. Push the branch to the repo with `git push -u origin <branchname>`
148
-
7. Run `np --any-branch`and follow its instructions
156
+
7. Run `yarn run publish`. (Not `yarn publish`) This will run `test` cases, check for`flow`and `lint` errors and then start the `lerna publish` process. You will prompted to choose the next versions for all the packages including `styled-components`. (Note: Packages which are marked as `private` will not be published to `npm`, choose any version for them).
149
157
8. Congratulations, you just published a new release of `styled-components`! :tada: Let everybody know on Twitter, in our community and all the other places
150
158
151
159
## Credits
152
160
153
161
These contribution guidelines are based on https://github.com/moya/contributors, big thanks to @alloy, @orta et al. for the inspiration and guidance.
154
162
155
-
156
163
## Financial contributions
157
164
158
165
We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/styled-components).
159
166
Anyone can file an expense. If the expense makes sense forthe development of the community, it will be "merged"in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.
160
167
161
-
162
168
## Credits
163
169
164
-
165
170
### Contributors
166
171
167
172
Thank you to all the people who have already contributed to styled-components!
Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/styled-components#sponsor))
0 commit comments