Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation about the debug script #187

Closed
8 tasks done
tech4GT opened this issue Feb 22, 2018 · 4 comments
Closed
8 tasks done

Add documentation about the debug script #187

tech4GT opened this issue Feb 22, 2018 · 4 comments

Comments

@tech4GT
Copy link
Member

tech4GT commented Feb 22, 2018

Hi, this is a first-timers-only issue. This means we've worked to make it more legible to folks who either haven't contributed to our codebase before, or even folks who haven't contributed to open source before.

If that's you, we're interested in helping you take the first step and can answer questions and help you out as you do. Note that we're especially interested in contributions from people from groups underrepresented in free and open source software!

If you have contributed before, consider leaving this one for someone new, and looking through our general help wanted issues. Thanks!😁

The problem

We need to add documentation for how to run the debug script

image-sequencer/src/ExportBin.js

"debug": "node index.js -i ./examples/images/monarch.png -s",

Solution
Add a few lines of description and an example about how to use the debug script to the README.md. It should look something like this

npm run debug invert

Steps to fix

  • claim
  • this issue with a comment
  • set up a repository locally and make sure that all tests pass
  • start a pull request (see contributing to Public Lab software) but mark it as "in progress"
  • fix the issue following the steps above
  • make sure all tests pass
  • alert someone via either the developers list (see below) to have your pull request merged. This may take a few extra steps depending on when you do it, but we'll help you out!
  • Please email the developers list (see https://publiclab.org/developers) if you have questions!
@jywarren
Copy link
Member

GitMate.io thinks the contributor most likely able to help you is @jywarren.

A possibly related issue is #170: Output not generated if contents of output folder are deleted.

@gayathriravipati
Copy link

I will take up this issue and solve it.This is the first time I am contributing here!

@tech4GT
Copy link
Member Author

tech4GT commented Feb 24, 2018

Sure go ahead, thanks for your help looking forward to your pr😁👍

@tech4GT
Copy link
Member Author

tech4GT commented Feb 27, 2018

closed via #192

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants