Data Admin Guidelines

Adding new repo

When adding a new repo for new game system, consider these things:

• repo address should be short, memorable and consist of small letters and dashes examples below;
• repo name/title should be written as it is originally examples below;
• create README - it is kind of a landing page for people who wandered onto repo website;
• provide link in Organisation Wiki page
• add the repo to appropriate org team - otherwise people won't be able to upload any commits

###Address/name examples:

address: wh40k

name: Warhammer 40k

address: battlefleetgothic

name: Battlefleet Gothic

###Create README

For consistency, copy-paste the contents below and rename title appropriately. You can of course add something about repo from yourself :)

Warhammer 40,000
================

####Contents####

* [Overview][]
* [Links][]

##Overview##
[Overview]: #overview

__What's this?__

BSData organisation created this project. It's GitHub repository of datafiles.
Maintained by community, in no way endorsed by BattleScribe. If you want
to develop - cool! We need you! Take a look at [Getting Started wiki][]

__Okay, nice project. Is it actually working?__ _I just want those files..._

Yeah! We have it hosted on AppSpot. Take a look: [BattleScribe Data on Appspot][]


##Links##
[Links]: #links

* [BattleScribe homepage][]
* [BattleScribe Data on Appspot][]
* [Getting Started wiki][]


[BattleScribe homepage]: http://www.battlescribe.net/
[BattleScribe Data on Appspot]: http://battlescribedata.appspot.com/#/repos
[Getting Started wiki]: https://github.com/BSData/bsdata/wiki/Home#getting-started

###Provide link

Add a link on the Joining Repository: click Edit, find 5th point in Getting Started section (##Getting started##), and add (in alphanumerically correct order) a position:

      * [RepoTitle](https://github.com/BSData/repo-address/issues/new?title=[Join%20Request])

where:

• RepoTitle is what users will see, the text of the link (repo title, full name);
• repo-address is the address of repo, ie wh40k for Warhammer 40k (you see it in address bar in browser);