Skip to content

Commit aa18721

Browse files
committed
Merge pull request #58 from plotly/better-contributing
Better contributing instructions
2 parents 7314a2c + ce736a8 commit aa18721

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,15 @@
55
Search for existing and closed issues. If your problem or idea is not addressed
66
yet, [please open a new issue](https://github.com/plotly/plotly.js/issues/new).
77

8+
Bug reports must be accompanied with a reproducible example. We recommend using
9+
[codepen](http://codepen.io/), [jsfiddle](https://jsfiddle.net/) or
10+
[jsbin](https://jsbin.com) to share your example.
11+
12+
Note that GitHub issues are reserved for bug reports and feature requests only.
13+
Implementation questions should be asked on Stack Overflow (tagged
14+
[`plotly`](https://stackoverflow.com/questions/tagged/plotly)) or on
15+
community.plot.ly (tagged [`plotly-js`](http://community.plot.ly/c/plotly-js)).
16+
817
### Development
918

1019
**Prerequisites**:
@@ -85,12 +94,12 @@ To view the results of a run on CircleCI, download the `build/test_images/` and
8594
### Repo organization
8695

8796
- Distributed files are in `dist/`
88-
- Sources files are in `src/`, including the index.
89-
- Build and repo management scripts are in `./tasks/`
97+
- Sources files are in `src/`, including the index
98+
- Build and repo management scripts are in `tasks/`
9099
- All tasks can be run using [`npm run-srcript`](https://docs.npmjs.com/cli/run-script)
91100
- Tests are `test/`, they are partitioned into `image` and `jasmine` tests
92101
- Test dashboard and image viewer code is in `devtools/`
93-
- Non-distributed, git-ignored built files are in `build/`
102+
- Non-distributed, git-ignored built files are in `build/`
94103

95104

96105
### Coding style

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Read the [Getting started page](https://plot.ly/javascript/getting-started/) for
4444
4545
## Bugs and feature requests
4646
47-
Have a bug or a feature request? Please first read the [issues guidelines](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md).
47+
Have a bug or a feature request? Please first read the [issues guidelines](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md#opening-issues).
4848
4949
## Documentation
5050

0 commit comments

Comments
 (0)