Add pull request and issue sections to Dev Guide

[jeddy3]

Ref: #2866

@hudochenkov Thanks for digging out those comments. I had completely forgotten about them :)

I’ve tried to streamline the pr and issue processes where I can e.g. I’ve removed the labels which we add to closed issues. Adding these labels is unnecessary work as this info is either:

1. Communicated in the closing comment e.g. “Best suited as a plugin”, “Dupe of xxxx” etc.
2. Implicit e.g. the PR was merged after a review, the PR is open and doesn’t have a “PR: needs tests/docs/revision” label and therefore needs reviewing.

The actual documents themselves are pretty terse (and a bit dry I’m afraid) as I wanted to get something up before we add any new members (and it's for a small audience).

---

I'll also try to make some time over the next few days to help work through the backlog of issues so there's a clean-ish slate for any new members...

[hudochenkov]

Excellent guides, @jeddy3!

There is small addition related to git history could be helpful.

There is also worth mention, that we need update package-lock.json if we update dependencies. Use latest npm, as it recommended.

[hudochenkov]

We could also add:

• Keep git history clean:
  • Start a commit message with uppercase letter.
  • Consider squash and merge commits instead simple merge. It's useful when PR has “Fix lint error,” “Fix typo,” “Update test snapshot”, etc.
  • Use git rebase in your own PRs to avoid unnecessary “Merge ...” commits.

[jeddy3]

Good idea. I've added bits about commit messages, squashing and rebasing.

[jeddy3]

There is also worth mention, that we need update package-lock.json if we update dependencies. Use latest npm, as it recommended.

Isn't the package-lock.json file automatically updated with a npm install package@latest command? If so, I think we don't need to document it... but we can always reassess if it becomes an issue. Although, maybe there is scope for adding another section to the developer guide e.g. prerequisites.md, which details node, npm, dependency updates etc. For another PR though :)

[hudochenkov]

Isn't the package-lock.json file automatically updated with a npm install package@latest command?

It is. But maintainer should use npm@5 for updating dependencies. Not everybody uses latest npm.

[jeddy3]

It is. But maintainer should use npm@5 for updating dependencies. Not everybody uses latest npm.

Fair point. I've added a "technical prerequisites to contributing" stub.

I also broke the developer guide into sections so that prerequisites make sense (and the user guide for consistency).

[hudochenkov]

The correct name is “Node.js.” Also, 8+ isn't a legit requirement. Personally, I'm using Node.js 6, and I'm going to switch to Node.js 8 only when it became LTS. I think the most correct version is 4 because it's a minimal version for stylelint itself.

[jeddy3]

You're right.

[ntwb]

LGTM

[ntwb]

This is 👌 , thanks @jeddy3 😄

[hudochenkov]

BTW, @jeddy3 didn't you delete by accident type: plugin label, when was deleting other labels? Just noticed, that this label is missing #2837 (comment).

[jeddy3]

BTW, @jeddy3 didn't you delete by accident type: plugin label, when was deleting other labels? Just noticed, that this label is missing #2837 (comment).

I deleted it as part of streamlining the processes (and therefore what I had to document). No 1. in #2868 (comment).