Update HACKING and rename it HACKING.md

[StoneyJackson]

It should contain

• [ ] expected workflow
• [ ] coding conventions
• [ ] contributor license agreement
• [ ] move developer/contributor stuff to HACKING

[kevin-brown]

Typically the contributing guidelines sit in a file called CONTRIBUTING.md which allows it to be picked up by GitHub when users are creating tickets or pull requests in the repository.

https://github.com/blog/1184-contributing-guidelines

Here are a few contributing guides that may be useful to look at.

https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md https://github.com/ivaynberg/select2/blob/master/CONTRIBUTING.md https://github.com/GNOME/evolution/blob/master/HACKING

[StoneyJackson]

@kevin-brown OK, I revised the title.

[StoneyJackson]

Proposed contributor workflow:

1. Identify or create a ticket, and assign to self
2. Fork via GitHub
3. Clone to local
4. Create a local branch to do the work in, giving it a meaningful name related to the issue.
5. Publish the branch to your fork
6. Create a pull request from the new branch (reference the issue either in the title or a comment of the pull request)
7. Do the work, pushing changes regularly to published branch
8. When you are ready for a code review, make a comment in your pull request like the following @kevin-brown ready for review.

The goal here is make sure that your efforts are visible. This will...

• Help avoid people accidentally working on the same issue (by assigning an issue to one's self)
• Allow others to identify what is actively being worked on (the PR and your published working branch)
• Allow others to identify stalled efforts (your published working branch), and reassign as necessary
• Allow others to pick up where someone else left of if they abandon their efforts (your published working branch)

[StoneyJackson]

@kevin-brown Oh hey, we have a HACKING, maybe we should better utilize that rather than creating yet another file. Should we move it to markdown, e.g, HACKING.md?

[kevin-brown]

I think the only reason why we had a HACKING file was because it wouldn't pass make dist-check without it. If it passes without it now (you never know), I'd be in favor of turning it into a CONTRIBUTING.md file.

[StoneyJackson]

Renaming it should be no problem with respect to make dist-check since we are "foreign" in configure.ac. That's why we can get away with README.md now.

https://github.com/GNOME-MouseTrap/mousetrap/blob/gnome3-wip/configure.ac#L4