ubuntu-packaging-guide-team team mailing list archive
-
ubuntu-packaging-guide-team team
-
Mailing list archive
-
Message #00137
[Bug 789975] Re: Please included a README or HACKING file
** Description changed:
It would be nice for new contributors if a file containing some pointers
existed. It should have:
* Philosophy behind the document (Does my article belong here?)
* An overview of the document's layout. (Where should a new article go?)
* A description of the desired editorial tone, voice, ect... (Should I be dry and technical or should I spice it up?)
+ * A description of any conventions used throughout. (Should I start a quoted command with a "$" or not?)
* Some brief examples of using ReStructured text (How do get started with writing for this?)
* A link to a more in depth ReStructured text tutorial
* Build instructions (How do I test that I didn't mess up the formatting?)
* ???
--
You received this bug notification because you are a member of Ubuntu
Packaging Guide Team, which is subscribed to Ubuntu Packaging Guide.
https://bugs.launchpad.net/bugs/789975
Title:
Please included a README or HACKING file
Status in Ubuntu Packaging Guide:
New
Bug description:
It would be nice for new contributors if a file containing some
pointers existed. It should have:
* Philosophy behind the document (Does my article belong here?)
* An overview of the document's layout. (Where should a new article go?)
* A description of the desired editorial tone, voice, ect... (Should I be dry and technical or should I spice it up?)
* A description of any conventions used throughout. (Should I start a quoted command with a "$" or not?)
* Some brief examples of using ReStructured text (How do get started with writing for this?)
* A link to a more in depth ReStructured text tutorial
* Build instructions (How do I test that I didn't mess up the formatting?)
* ???
References