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

Contributing instructions in README.md could be clearer #77

Closed
houli opened this issue Oct 21, 2017 · 12 comments
Closed

Contributing instructions in README.md could be clearer #77

houli opened this issue Oct 21, 2017 · 12 comments

Comments

@houli
Copy link
Contributor

houli commented Oct 21, 2017

I was confused about what exactly to put as my bower.json in my exercise directory. The README mentions the master bower.json file but I wasn't sure if I was to just copy it into my directory or if I should tailor my dependencies specifically for the exercise. One particular problem is that the version of readlink on macOS doesn't have a -f flag and the check-bower.sh and update-bower.sh scripts fail to run.

One thing that might be worth adding is writing out a full step-by-step for creating a new exercise by first showing a file system tree ASCII diagram of what an exercise looks like and some general instructions (not specific terminal commands if possible) for creating that structure. Something like

  1. Create the directory for the exercise in exercises with the name of the exercise
  2. Create directories examples src test in your exercise directory
  3. Use bin/fetch-configlet && bin/configlet generate . --only exercise-name to generate the README.md
  4. Use bin/update-bower.sh to generate the bower.json
  5. Use bin/configlet uuid to generate a new UUID for the exercise
  6. Add details to config.json
    etc.
@icyrockcom
Copy link
Contributor

Thanks for listing these out.

readlink on macOS doesn't have a -f flag and the check-bower.sh and update-bower.sh scripts fail to run.

OK, that sucks. I'll have to look into how to go around that.

Valid points otherwise, I'll do a PR to update.

@stale
Copy link

stale bot commented Dec 24, 2017

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix label Dec 24, 2017
@lpil lpil removed the wontfix label Dec 24, 2017
@lpil
Copy link
Sponsor Member

lpil commented Dec 24, 2017

Keep please bot :)

@stale
Copy link

stale bot commented Feb 22, 2018

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix label Feb 22, 2018
@icyrockcom
Copy link
Contributor

Keep it open :)

@stale stale bot removed the wontfix label Feb 23, 2018
@stale
Copy link

stale bot commented Apr 24, 2018

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix label Apr 24, 2018
@icyrockcom
Copy link
Contributor

Keep it open :)

@stale
Copy link

stale bot commented Jun 25, 2018

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix label Jun 25, 2018
@icyrockcom
Copy link
Contributor

Keep it open

@stale stale bot removed the wontfix label Jun 28, 2018
@icyrockcom
Copy link
Contributor

@houli I pushed this one, please check it out if you have a moment (see the pull request for additional details). Just wanted to confirm if it works for you now before merging.

#95

@houli
Copy link
Contributor Author

houli commented Sep 1, 2018

Yep, looks good

@lpil lpil closed this as completed in a0ca98d Sep 2, 2018
@icyrockcom
Copy link
Contributor

Great thanks both!

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

No branches or pull requests

3 participants