Skip to content

Commit d837fc4

Browse files
benvinegarLewisJEllis
authored andcommitted
Update CONTRIBUTING.md w/ detail on opening issues (#726)
* Update CONTRIBUTING.md w/ detail on opening issues * Fix newlines, settle on JSFiddle
1 parent 6920e38 commit d837fc4

File tree

1 file changed

+50
-20
lines changed

1 file changed

+50
-20
lines changed

CONTRIBUTING.md

Lines changed: 50 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,34 @@
11
# Contributing
22

3-
## Setting up an Environment
3+
## Reporting Issues and Asking Questions
4+
5+
Before opening an issue, please search the issue tracker to make sure your issue hasn't already been reported.
6+
7+
## Bugs and Improvements
8+
9+
We use the issue tracker to keep track of bugs and improvements to Raven.js itself, plugins, and the documentation. We encourage you to open issues to discuss improvements, architecture, implementation, etc. If a topic has been discussed before, we will ask you to join the previous discussion.
10+
11+
## Getting Help
12+
13+
For support or usage questions like “how do I do X with Raven.js and “my code doesn't work”, please search and ask on the [Sentry forum](https://forum.sentry.io).
14+
15+
## Help Us Help You
16+
17+
On both GitHub and the Sentry forum, it is a good idea to structure your code and question in a way that is easy to read and understand. For example, we encourage you to use syntax highlighting, indentation, and split text in paragraphs.
18+
19+
Additionally, it is helpful if you can let us know:
20+
21+
* The version of Raven.js affected
22+
* The browser and OS affected
23+
* Which Raven.js plugins are enabled, if any
24+
* If you are using [hosted Sentry](https://sentry.io) or on-premises, and if the latter, which version (e.g. 8.7.0)
25+
* If you are using the Raven CDN (http://ravenjs.com)
26+
27+
Lastly, it is strongly encouraged to provide a small project reproducing your issue. You can put your code on [JSFiddle](https://jsfiddle.net/) or, for bigger projects, on GitHub. Make sure all the necessary dependencies are declared in package.json so anyone can run npm install && npm start and reproduce your issue.
28+
29+
## Development
30+
31+
### Setting up an Environment
432

533
To run the test suite and run our code linter, node.js and npm are required. If you don't have node installed, [get it here](http://nodejs.org/download/) first.
634

@@ -16,7 +44,7 @@ And if you don't have [Grunt](http://gruntjs.com/) already, feel free to install
1644
$ npm install -g grunt-cli
1745
```
1846

19-
## Running the Test Suite
47+
### Running the Test Suite
2048

2149
The test suite is powered by [Mocha](http://visionmedia.github.com/mocha/) and can both run from the command line or in the browser.
2250

@@ -34,7 +62,7 @@ $ grunt run:test
3462

3563
Then visit: http://localhost:8000/test/
3664

37-
## Compiling Raven.js
65+
### Compiling Raven.js
3866

3967
The simplest way to compile your own version of Raven.js is with the supplied grunt command:
4068

@@ -79,20 +107,22 @@ $ grunt run:docs
79107

80108
## Releasing New Version
81109

82-
* Verify TypeScript [language definition file](https://github.com/getsentry/raven-js/blob/master/typescript/raven.d.ts) is up to date
83-
* Bump version numbers in both `package.json` and `bower.json`.
84-
* Bump version across all docs under `docs/`
85-
* Put together [CHANGELOG](https://github.com/getsentry/raven-js/blob/master/CHANGELOG.md)
86-
* `$ grunt dist` This will compile a new version and update it in the `dist/` folder.
87-
* Confirm that build was fine, etc.
88-
* Commit new version, create a tag. Push to GitHub.
89-
* Copy CHANGELOG entry into a new GH Release: https://github.com/getsentry/raven-js/releases
90-
* `$ grunt publish` to recompile all plugins and all permutations and upload to S3.
91-
* `$ npm publish` to push to npm.
92-
* Confirm that the new version exists behind `cdn.ravenjs.com`
93-
* Bump version in the `gh-pages` branch specifically for http://ravenjs.com/.
94-
* Bump marketing pages on sentry.io, e.g. https://sentry.io/for/javascript/
95-
* Bump sentry.io `<script>` tag of raven.js
96-
* Bump `package.json` in Sentry repo https://github.com/getsentry/sentry/blob/master/package.json
97-
* Bump version for Segment integration since they don't: https://github.com/segment-integrations/analytics.js-integration-sentry
98-
* glhf
110+
_This is a checklist for core contributors when releasing a new version._
111+
112+
* [ ] Verify TypeScript [language definition file](https://github.com/getsentry/raven-js/blob/master/typescript/raven.d.ts) is up to date
113+
* [ ] Bump version numbers in both `package.json` and `bower.json`.
114+
* [ ] Bump version across all docs under `docs/`
115+
* [ ] Put together [CHANGELOG](https://github.com/getsentry/raven-js/blob/master/CHANGELOG.md)
116+
* [ ] `$ grunt dist` This will compile a new version and update it in the `dist/` folder.
117+
* [ ] Confirm that build was fine, etc.
118+
* [ ] Commit new version, create a tag. Push to GitHub.
119+
* [ ] Copy CHANGELOG entry into a new GH Release: https://github.com/getsentry/raven-js/releases
120+
* [ ] `$ grunt publish` to recompile all plugins and all permutations and upload to S3.
121+
* [ ] `$ npm publish` to push to npm.
122+
* [ ] Confirm that the new version exists behind `cdn.ravenjs.com`
123+
* [ ] Bump version in the `gh-pages` branch specifically for http://ravenjs.com/.
124+
* [ ] Bump marketing pages on sentry.io, e.g. https://sentry.io/for/javascript/
125+
* [ ] Bump sentry.io `<script>` tag of raven.js
126+
* [ ] Bump `package.json` in Sentry repo https://github.com/getsentry/sentry/blob/master/package.json
127+
* [ ] Bump version for Segment integration since they don't: https://github.com/segment-integrations/analytics.js-integration-sentry
128+
* [ ] glhf

0 commit comments

Comments
 (0)