Skip to content

Commit e98c481

Browse files
pushpinder107danielcaldas
authored andcommitted
Fix typos (#279)
1 parent 539a03a commit e98c481

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ npm install react-d3-graph
4747

4848
#### About react and d3 peer dependencies
4949

50-
**Note** that `react` and `d3` are [peer-dependencies](https://nodejs.org/en/blog/npm/peer-dependencies/), this means that the responsability to install them is delegated to the client. This will give you a bigger flexibility on what versions of `d3` and `react` you want to consume, you just need to make sure that you are compliant with the range of versions that `react-d3-graph` is compatible with. If you install `react-d3-graph` without first installing `d3` and `react` you might be propmt the following warnings:
50+
**Note** that `react` and `d3` are [peer-dependencies](https://nodejs.org/en/blog/npm/peer-dependencies/), this means that the responsibility to install them is delegated to the client. This will give you more flexibility on what versions of `d3` and `react` you want to consume, you just need to make sure that you are compliant with the range of versions that `react-d3-graph` is compatible with. If you install `react-d3-graph` without first installing `d3` and `react` you might see the following warnings:
5151

5252
> npm WARN [email protected] requires a peer of d3@^5.5.0 but none is installed. You must install peer dependencies yourself.
5353
> npm WARN [email protected] requires a peer of react@^16.4.1 but none is installed. You must install peer dependencies yourself.
@@ -144,17 +144,17 @@ const onNodePositionChange = function(nodeId, x, y) {
144144

145145
## Contributions
146146

147-
Contributions are welcome fell free to submit new ideas/features, just open an issue or send me an email or something. If you are more a _hands on_ person, just submit a pull request. Before jumping into coding, please take at the contribution guidelines [CONTRIBUTING.md](https://github.com/danielcaldas/react-d3-graph/blob/master/CONTRIBUTING.md).
147+
Contributions are welcome, feel free to submit new ideas/features, just open an issue or send me an email or something. If you are more a _hands on_ person, just submit a pull request. Before jumping into coding, please take a look at the contribution guidelines [CONTRIBUTING.md](https://github.com/danielcaldas/react-d3-graph/blob/master/CONTRIBUTING.md).
148148

149149
To run react-d3-graph in development mode you just need to run `npm run dev` and the interactive sandbox will reload with the changes to the library code, that way you can test your changes not only through unit test but also through a real life example. It's that simple. The development workflow usually should follow the steps:
150150

151-
- Create a branch prefixed with `fix/` for bug fixes, `feature/` for new features, `chore/` or `refactor/` for refactoring or tolling and CI/CD related tasks.
151+
- Create a branch prefixed with `fix/` for bug fixes, `feature/` for new features, `chore/` or `refactor/` for refactoring or tooling and CI/CD related tasks.
152152
- Make sure you are up to date running `npm install`.
153153
- Run `npm run dev`.
154-
- Do you changes inside the folder `src` and the interactive sandbox consumes your changes in real time
154+
- Make you changes inside the folder `src` and the interactive sandbox consumes your changes in real time
155155
with webpack-dev-server.
156156
- You can run tests locally with `npm run test` (for unit tests) or `npm run functional:local` for e2e tests.
157-
- After you're done open the Pull Request and describe the changes you've made.
157+
- After you're done, open the Pull Request and describe the changes you've made.
158158

159159
## Alternatives (Not what you where looking for?)
160160

0 commit comments

Comments
 (0)