refactor: contributing readme updated

Author: roggervalf

.travis.yml

@@ -23,13 +23,13 @@ script:
   - yarn
   - yarn build
 
-deploy:
-  provider: pages
-  skip_cleanup: true
-  token: $GH_TOKEN
-  keep_history: true
-  on:
-    branch: refactoring
+#deploy:
+#  provider: pages
+#  skip_cleanup: true
+#  token: $GH_TOKEN
+#  keep_history: true
+#  on:
+#    branch: refactoring
 
 after_success:
   - yarn semantic-release

contributing.md

@@ -4,24 +4,31 @@ This doc needs help! Please submit your PR...
 
 ## Commit messages
 
-We are using semantic-release to automate the release process, and this depends on a specific format for commit messages. Please run `npm run commit` to use `commitizen` to properly format your commit messages so they can be automatically processed and included in release notes.
+We are using semantic-release to automate the release process, and this depends on a specific format for commit messages. Please run `yarn commit` to use `commitizen` to properly format your commit messages so they can be automatically processed and included in release notes.
 
 ## Pull request testing
 
 Some notes on testing and releasing.
 * For a PR, follow Github's command-line instructions for retrieving the branch with the changes.
-* `make dev` starts a development server, open `http://localhost:8888` to see the example website.
+* To start a development server:
+
+```sh
+yarn build
+cd example
+yarn
+yarn start
+```
+
 * Provide feedback on the PR about your results.
 
 ## Doing a release
 
 We are using semantic-release instead of this:
 
-* `make deploy` updates the files in the `standalone` directory
 * update the version number in `package.json`
-    - Fixes update the patch number, features update the minor number.
-    - Major version update is reserved for API breaking changes, not just additions. 
-* `npm run github-changes -- -n 3.X.Y` to update the changelog
+  - Fixes update the patch number, features update the minor number.
+  - Major version update is reserved for API breaking changes, not just additions.
+* `yarn github-changes -- -n 3.X.Y` to update the changelog
 * `git add`, `git commit` and `git push` to get the version to master.
 * `git tag -a 3.X.Y -m 3.X.Y` `git push --tags`
 * `npm publish`

example/src/App.js

@@ -217,7 +217,7 @@ export default class App extends Component {
                 {'(〃∀〃)'}
                 </a>
               </div>
-              <ReactTooltip id="global" aria-haspopup="true" role="example">
+              <ReactTooltip id="global" aria-haspopup="true">
                 <p>This is a global react component tooltip</p>
                 <p>You can put every thing here</p>
                 <ul>
@@ -232,7 +232,7 @@ export default class App extends Component {
                 <p>
                   {"<a data-tip data-for='global'> σ`∀´)σ </a>\n" +
                     "<a data-tip data-for='global'> (〃∀〃) </a>\n" +
-                    "<ReactTooltip id='global' aria-haspopup='true' role='example'>\n" +
+                    "<ReactTooltip id='global' aria-haspopup='true' >\n" +
                     " <p>This is a global react component tooltip</p>\n" +
                     " <p>You can put every thing here</p>\n" +
                     " <ul>\n" +
@@ -430,7 +430,7 @@ export default class App extends Component {
                 <p>
                   {"<a data-for='enrich' data-tip='sooooo cute'>(❂‿❂)</a>\n" +
                     "<a data-for='enrich' data-tip='really high'>(❂‿❂)</a>\n" +
-                    "<ReactTooltip id='enrich' getContent={(dataTip) => `This little buddy is ${dataTip}`}/>"}
+                    `<ReactTooltip id='enrich' getContent={(dataTip) => \`This little buddy is \${dataTip}\`}/>`}
                 </p>
               </div>
             </pre>
@@ -738,7 +738,7 @@ export default class App extends Component {
                   <div>header</div>
                   <img
                     src="http://lorempixel.com/100/1500"
-                    alt="lorem image 100x1500"
+                    alt="lorem 100x1500"
                   />
                   <div>footer</div>
                 </ReactTooltip>
@@ -749,7 +749,7 @@ export default class App extends Component {
                   <div>header</div>
                   <img
                     src="http://lorempixel.com/100/1500"
-                    alt="lorem image 100x1500"
+                    alt="lorem 100x1500"
                   />
                   <div>footer</div>
                 </ReactTooltip>