question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Improving CONTRIBUTING.md

See original GitHub issue

The CONTRIBUTING.md is outdated and needs some updates, for example it’s not mentioned anything about building or running the project.


For building the first time:

Unix

yarn && npx lerna bootstrap && npx lerna run build

Windows

yarn
npx lerna bootstrap
npx lerna run build

For building local packages it’s possible to run only

yarn build

in every folder with a package.json file


For running demos

yarn start

or

yarn serve

where the start commands returns an error (this could be another improvement)

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:9 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
utkarshhbtucommented, Oct 7, 2021

can i work on this issue

0reactions
tamoghna-deycommented, Oct 20, 2021

I just submitted a PR.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Good-CONTRIBUTING.md-template.md - gists · GitHub
Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning...
Read more >
Best practices to manage an open source project
The CONTRIBUTING.md file is a short guide to potential contributors on how they can contribute to your open source project. You can see...
Read more >
How to fill out the CONTRIBUTING.md template - IEEE GitLab
This is an excellent way to have participants begin making contributions. Adding productive contributors should be a key objective of any ...
Read more >
Write Better Docs - Linux Foundation Events
CONTRIBUTING.md +. DEVELOPMENT.md. 3. A surprise! Page 23. @bobcatwilson. CONTRIBUTING.md and.
Read more >
Get Others Involved in Your Project with a CONTRIBUTING ...
I recently shared a README Template and strategies for improving your project's README . The README 's purpose is to introduce new users...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found