Difference between revisions of "Developer"

From BOARD18 Project WIKI
Jump to navigation Jump to search
(→‎Submitting Merge Requests: added new section)
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
==Developer Guidelines==
__NOTOC__
BOARD18 is currently a '''very''' small project.
{{:Developer.Guidelines}}
At the time of this writing only 4 people have contributed code, documentation or other work to BOARD18.  <br>The testing community for the pre Alpha testing consisted of 10 people.
Thus there is not much formal structure to the project yet.


The creator and main designer/coder of BOARD18 is Rich Price. And he could be considered the informal project leader. You can contact him on the forums or by email to '''rich at gandalf.ws'''.
==Developer Documentation==
 
The bulk of the documentation of the BOARD18 code base is contained in this [[Design Document Introduction|BOARD18 Design Document]].<br>
===Communication with other Developers===
It is fairly up to date but some sections may need some revision.<br>
The BOARD18 project has a brand spanking new forum at [http://forum.board18.org forum.board18.org]. Rich Price monitors all of the existing sub forums. It is hoped that developers will use the developers forum to communicate coding information and to announce bug submissions and merge requests to each other.
Learning the code by comparing it to the relevant sections of the design document is encouraged. <br>A side effect of this could be updates and corrections to this design document. This is a WIKI after all!
 
===Reporting Bugs===
The BOARD18 project also has a brand spanking new issue tracker (bugzilla) at
[http://bugs.board18.org bugs.board18.org]. This tool should be used to track bugs, enhancement requests and other tasks. The bug list should be a good source of ideas for developers looking for something to do.


===Submitting Merge Requests===
The [[:Category:HowTo|index of How To pages]] could also be of help when getting started in this project.
The BOARD18 project keeps its repositories at [https://gitorious.org/board18 Gitorious]. 
'''Use [[How To Contribute Code|this How To document]] as a guide to using Gitorious.'''


==Developer Documentation==
And I have finally started work developing some [[Coding Standards Introduction|coding standards]] for the BOARD18 project.

Latest revision as of 08:38, 14 October 2017

Developer Guidelines

BOARD18 is a very small project. At the time of this writing only 10 people have contributed code, documentation or other work to BOARD18.
The testing community for BOARD18 consists of fewer than 20 people. Thus there is no formal structure to the project.
The creator and main designer/coder of BOARD18 is Rich Price. And he is also the owner of the project.
You can contact him by email at rich at board18.org.

Reporting Bugs

The BOARD18 project also has a BUGZILLA issue tracker at bugs.board18.org. This tool is used to track bugs, enhancement requests and other tasks.

BOARD18 Code Repositories

The BOARD18 project keeps its code repositories at Github.

Developer Documentation

The bulk of the documentation of the BOARD18 code base is contained in this BOARD18 Design Document.
It is fairly up to date but some sections may need some revision.
Learning the code by comparing it to the relevant sections of the design document is encouraged.
A side effect of this could be updates and corrections to this design document. This is a WIKI after all!

The index of How To pages could also be of help when getting started in this project.

And I have finally started work developing some coding standards for the BOARD18 project.