Git: Difference between revisions
Jump to navigation
Jump to search
(IRC Channel -> IRC channel) |
(Add Organization section, linking all xoreos repositories) |
||
| Line 1: | Line 1: | ||
=Organization= | |||
The official xoreos repositories can be found [https://github.com/xoreos/ here on GitHub]. They are: | |||
* [https://github.com/xoreos/xoreos xoreos], the main xoreos repository | |||
* [https://github.com/xoreos/xoreos-tools xoreos-tools], various tools to help development and modding | |||
* [https://github.com/xoreos/phaethon Phaethon], a WIP graphical resource explorer | |||
* [https://github.com/xoreos/xoreos-web xoreos-web], which contains the website at [https://xoreos.org xoreos.org] | |||
* [https://github.com/xoreos/xoreos-docs xoreos-docs], miscellaneous file format specifications | |||
* [https://github.com/xoreos/xoreos-media xoreos-media], containing xoreos icons and logos | |||
* [https://github.com/xoreos/xoreos-wiki xoreos-wiki], a public mirror of this wiki | |||
=Retrieving the code= | =Retrieving the code= | ||
| Line 10: | Line 22: | ||
Refer to github help documentation on where to obtain git client for your OS. | Refer to github help documentation on where to obtain git client for your OS. | ||
The other repositories can be cloned similarity. | |||
=Keeping updated= | =Keeping updated= | ||
* You can [https://github.com/xoreos browse] the Git repositories through HTTP. | * You can [https://github.com/xoreos browse] the Git repositories through HTTP. | ||
* For every push: | * For every push: | ||
| Line 18: | Line 33: | ||
=Committing= | =Committing= | ||
* Before you write/submit code, you must read about our [[Code Formatting Conventions]]. Patches which do not follow them will be rejected or at least delayed until they are cleaned up to comply to them. | * Before you write/submit code, you must read about our [[Code Formatting Conventions]]. Patches which do not follow them will be rejected or at least delayed until they are cleaned up to comply to them. | ||
* If you have write access to our repository, you are expected to have read and to comply to the [[Commit Guidelines]]. | * If you have write access to our repository, you are expected to have read and to comply to the [[Commit Guidelines]]. | ||
| Line 23: | Line 39: | ||
=Repository Statistics= | =Repository Statistics= | ||
Our commit logs are fed to these freely available statistics tools: | Our commit logs are fed to these freely available statistics tools: | ||
* [https://www.ohloh.net/p/xoreos ohloh project analysis] nice graphs and devs activity | * [https://www.ohloh.net/p/xoreos ohloh project analysis] nice graphs and devs activity | ||
Revision as of 23:09, 4 December 2015
Organization
The official xoreos repositories can be found here on GitHub. They are:
- xoreos, the main xoreos repository
- xoreos-tools, various tools to help development and modding
- Phaethon, a WIP graphical resource explorer
- xoreos-web, which contains the website at xoreos.org
- xoreos-docs, miscellaneous file format specifications
- xoreos-media, containing xoreos icons and logos
- xoreos-wiki, a public mirror of this wiki
Retrieving the code
The main repository is located at
git://github.com/xoreos/xoreos.git
If you are using command line git, the command to get the repository is:
git clone git://github.com/xoreos/xoreos.git
Refer to github help documentation on where to obtain git client for your OS.
The other repositories can be cloned similarity.
Keeping updated
- You can browse the Git repositories through HTTP.
- For every push:
- A mail with the commit(s) diff(s) is sent to the xoreos-git mailing list.
- The GitHub bot notifies the IRC channel with the summary of the commit(s).
Committing
- Before you write/submit code, you must read about our Code Formatting Conventions. Patches which do not follow them will be rejected or at least delayed until they are cleaned up to comply to them.
- If you have write access to our repository, you are expected to have read and to comply to the Commit Guidelines.
- You may also find ScummVM's Git tips page useful.
Repository Statistics
Our commit logs are fed to these freely available statistics tools:
- ohloh project analysis nice graphs and devs activity