Add installation guide, improve README, fixed broken badges and create CONTRIBUTING.md
#1248
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
| [](https://lgtm.com/projects/g/rollbar/rollbar.js/context:javascript) | ||
| [](https://lgtm.com/projects/g/rollbar/rollbar.js/alerts) | ||
| [](https://www.npmjs.com/package/rollbar) | ||
| [](https://www.npmjs.com/package/rollbar) |
There was a problem hiding this comment.
lgtm was deprecated by github in favor of their native "code scanning" thing which I haven't investigated, decided however to remove these and do (what seems to be) the more classic npm version+downloads.
We have 1.5M dl a month which seemed like a nice number to show off.
README.md
Outdated
| ## Usage and Reference | ||
|
|
||
| For complete usage instructions and configuration reference, see our [Javascript SDK docs](https://docs.rollbar.com/docs/javascript). | ||
|
|
||
| ### Examples | ||
|
|
||
| See the [examples directory](./examples/) for detailed integration examples with various frameworks and build tools including React, Angular, Vue.js, Next.js, and more. |
There was a problem hiding this comment.
This should link straight to the dir, which now contains a README.md itself.
| @@ -45,10 +106,11 @@ For bug reports, please [open an issue on GitHub](https://github.com/rollbar/rol | |||
|
|
|||
| To set up a development environment, you'll need Node.js and npm. | |||
|
|
|||
| 2. `npm install -D` | |||
There was a problem hiding this comment.
I'm not sure why the -D...?
README.md
Outdated
| To run the tests, run `make test`. | ||
| To run the tests: `npm test` |
There was a problem hiding this comment.
Don't know why do we even have a Makefile, do js devs not know how to use npm? 😂
I was tempted to remove the Makefile, but I'm not sure if its being used by the CI or something else.
matux
changed the title
README, fixed broken badged and create CONTRIBUTING.mdREADME, fixed broken badges and create CONTRIBUTING.md
matux
force-pushed
the
matux/update-readme
branch
from
06aa5b0 to
626c916
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR improves the project's documentation and contributor experience by adding installation instructions, fixing broken badges, and establishing contribution guidelines. The changes focus on making the project more accessible to new users and contributors.
- Added comprehensive installation and quick start sections with code examples for multiple environments
- Replaced non-functional LGTM badges with working npm badges
- Created a detailed contributing guide with development workflow instructions
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Added installation section, quick start examples, replaced broken badges, and streamlined content |
| examples/README.md | Improved table formatting, updated code examples, and enhanced documentation clarity |
| CONTRIBUTING.md | New comprehensive guide for contributors with setup, workflow, and submission guidelines |
Description of the change
Note
PR description generated by Claude Code
README.md
Added Installation section with npm, yarn, and CDN options
Added Quick Start section with code examples for:
Added link to examples directory for framework-specific integrations
I've also made sure all links are working correctly, except for some that seem to link to the same place (although correctly), all seems okay.
Replaced non-functional LGTM badges (service discontinued by GitHub) with:
Before
After
CONTRIBUTING.md
Note
Generated by Claude Code.
examples/README.md
modulefield in package.json for ES module supportType of change