Chapter 1 Writing Modules

[davidmarkclements]

No description provided.

[davidmarkclements]

yah - sorry for delay
okay

1. git clone this repo
2. git fetch --all
3. git checkout Chapter-1
4. insert a comment in the following form: <comment> your comment </comment> - don't worry about dating it or labelling it as your comment, the git logs will show that
5. when done, git add content.md then git commit -m 'review' then git push
6. I'll address each of the comments, with the following <response> my response </response>
7. comments and responses can remain until we're satisfied that the review is complete, I'll then remove all and tags (I'll write a script to do this). I may also add an option to hyperpdf to render the comments and responses in an easy to read format.

[davidmarkclements]

to be clear a comment can go anyway, e.g.

![](images/fig1.1.png)<comment> a comment </comment>
*An `npm init` should look like this*


Upon completion we should have a `package.json`<comment> another comment</comment> file that looks something like the following:

<code>
{
  "name": "hsl-to-hex",
  "version": "1.0.0",
  "description": "",<comment> another comment </comment>
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "David Mark Clements",
  "license": "MIT"
}
</code>

### How it Works<comment> yet another comment </comment>

When Node is installed on our system, `npm` comes bundled with it.

The `npm` executable is written in JavaScript, and runs on Node.

[davidmarkclements]

also feel free to abbreviate to <cmt> and <res> we'll support both

[davidmarkclements]

example of comment-response interaction:

some text etc. more <comment> comment here <response> response is nested in comment to show association <response> additional reply to the response can be nested inside first response <response>and so on</response> </response> </response> </comment> text blah blah 

[aruntnadar]

@davidmarkclements Just saw the notification. I'll start working on this chapter today.

[aruntnadar]

@davidmarkclements

On git bash I typed

"git clone https://github.com/PacktPublishing/Node-Cookbook-3rd-Ed.git"
then
"git fetch --all"
"git checkout Chapter-1" - this line doesn't work because this is not present in my local machine.
Only the readme, outline, TOC, and 2 image files got cloned. How should I clone chapter 1? Could you please help me out.
Tried changing the branch to Chapter-1, but cloning doesn't work. Am I doing something wrong?

[davidmarkclements]

sorry try this:

git branch -D Chapter-1
git fetch origin
git checkout -b Chapter-1 origin/Chapter-1

[aruntnadar]

Could you please check this screenshot. I am getting an error.

[davidmarkclements]

@aruntnadar I can only guess that you're using and old version or obscure fork of git.

What you need to do is check out a remote branch, try ideas from http://stackoverflow.com/questions/1783405/checkout-remote-git-branch to begin with

[aruntnadar]

@davidmarkclements Please check the screenshot. I was able to switch from master to Chapter-1, but I am not able to clone the files from branch Chapter-1. Also, I wanted to ask whether the URL of master branch and Chapter-1 is same, because when I clone, only these following files are getting downloaded to the local machine.

[davidmarkclements]

1. you're cloning but you're already in the repo - you've already cloned, only need to do that once
2. the -b flag creates a new branch. you don't want to do that, you want to check out an existing (remote) branch

[aruntnadar]

@davidmarkclements Finally! Fetched the content of Chapter 1. I'll start working on it now.

How is the next chapter coming along? When can I expect the next chapter?

[aruntnadar]

@davidmarkclements I evaluated the first recipe in the chapter. Please have a look at the changes and suggestions, and let me know if this kind of feedback works, I'll then proceed ahead.

[davidmarkclements]

@aruntnadar - you haven't pushed your changes to branch...

git add .
commit -m 'review'
git push

[aruntnadar]

@davidmarkclements - could you please check now. I have attached a screenshot of the steps that I did:

[davidmarkclements]

if you look at the commits tab, you can see that nothing has been pushed,
that's because you're pushing to the master branch of your own repo (https://github.com/aruntnadar/Node-Cookbook-3rd-Ed.git)

@aruntnadar I think another approach may be necessary here, how about this

1. add comments to the generated PDF
2. attach the PDF to this thread
3. I'll respond to comments in the PDF
4. any edits I need to make I'll make in the markdown and push

[aruntnadar]

1-Writing-Modules.pdf
@davidmarkclements: Chapter 1 has been editorially evaluated. Do let me know in case you have any queries. For now focus on the next chapters, my comments and reviewer comments that will be added can be addressed once all the chapters are done. You can refer to the comments in the file though, it will help you write the further chapters.

[aruntnadar]

@davidmarkclements : Could you please help me out with how to apply labels?

[davidmarkclements]

@aruntnadar - https://help.github.com/articles/creating-and-editing-labels-for-issues-and-pull-requests/

[aruntnadar]

@davidmarkclements This is for creating and editing labels, which I did. I checked applying Labels as well: https://help.github.com/articles/applying-labels-to-issues-and-pull-requests/

I am not able to do the third step in that link because there is no checkbox available.