Create Contributor Manual Template

[graphitefriction]

Produce template covering contribution guidelines and conventions for all aspects of the Asciidoctor project including:

• Website
• Docs
• Core Code
• Integration Code
• Extensions Code

[mojavelinux]

One of the key parts of this template should be "how to build the latest code". We often ask for feedback, but without this guide, people often feel stuck waiting around for a release. If we want feedback, we need to help them understand how to try the lastest code. The steps vary depending on the the module.

[graphitefriction]

@mojavelinux Would these be the same instructions you provided here asciidoctor/asciidoctor#460 (comment) and/or using a pre-release gem?

[mojavelinux]

That's one way. The other way is to git clone the project (or download the
archive, extract and rename folder to asciidoctor), then run:

cd asciidoctor
bundle install
rake build
gem install pkg/*.gem

That builds the gem and installs it without using the remote RubyGems
server.

The final way, which I use hundreds of times a day is to invoke the
asciidoctor command directly out of the source folder.

./bin/asciidoctor

The asciidoctor command knows how to find the libraries inside the same
project.

Also, tests can be run using:

rake

A single test file can be run using:

testrb -Ilib tests/document_tests.rb

(That's a capital "i" as in "include" followed by a lowercase "lib" as in
"library" after the - in the previous command).

[jaredmorgs]

I think even describing how docs contributors should name their PRs (Issue-123) and suggesting how they use git commit --amend to update one commit with their PR content would be hugely helpful.

These may be reflex actions to most experienced git users, but folks who are perhaps using Asciidoctor as their first Open Source GitHub foray may find this type of guidance invaluable.

[mojavelinux]

I agree (and I have no doubt Sarah does too) that being explicit is good. Like giving driving directions, choose big landmarks instead of subtle clues that are hard to detect.

[mojavelinux]

This is now a duplicate of asciidoctor/asciidoctor-community-docs#2.