asciidoctor / docbookrx

(An early version of) a DocBook to AsciiDoc converter written in Ruby.
MIT License
22 stars 49 forks source link

Create a contributing guide #50

Open mojavelinux opened 8 years ago

mojavelinux commented 8 years ago

This project should have a contributing guide (named CONTRIBUTING.adoc). It should explain how to get setup for development (pulling in content from the README), how to run tests, preferred coding style and goals for the project.

We can draw generic content and messaging from other contributing guides in the ecosystem (See https://github.com/asciidoctor/atom-language-asciidoc/blob/master/CONTRIBUTING.adoc and https://github.com/asciidoctor/asciidoctor.js/blob/master/CONTRIBUTING.adoc). What should be unique about this contributing guide is a clear list of goals for the project. Here's a draft of those goals:

The document doesn't have to be perfect to start. What's most important is that we get it started.

mojavelinux commented 8 years ago

The following section from the Jekyll AsciiDoc plugin describes the coding style I'd like to adopt for this project:

https://github.com/asciidoctor/jekyll-asciidoc#coding-style