OdaWiki

Difference between revisions of "Subversion"

From OdaWiki
 
(39 intermediate revisions by 6 users not shown)
Line 1: Line 1:
−
[[Image:Commits_group_multi_author_graph.png|thumb|Graph of svn activity up to revision 1254]]
+
== What is Github? ==
  
−
SubVersion is the current version control repository used to maintain the odamex source code. Access is restricted based on our [[Policy]].
+
Github is the current version control repository used to maintain the Odamex source code. In layman's terms, it allows multiple people to be working on the same project at the same time while giving those same people the facilities to recognize collisions between two contributors code.
  
−
== Tested clients ==
+
== How do I access Odamex's Github respository? ==
  
−
* [http://subversion.tigris.org/ svn]
+
Odamex's Github repository can be accessed using the following URL:
−
* [http://tortoisesvn.tigris.org/ tortoisesvn] for [[Windows]]
+
  
−
== Directory structure ==
+
<pre>https://github.com/odamex/odamex</pre>
  
−
Each branch keeps an entire odamex source tree.
+
== What is Odamex's Github access policy? ==
  
−
* '''[http://www.odamex.net/svn root]'''
+
Read-only access to Odamex's Github repository is public, meaning that anyone can checkout the source for their own purposes, including modification and compilation.  However, further repository access, such as Commit access, is restricted based on our [[Policy]]. If you wish to contribute to Odamex, please send a [[patch]] to one of the indicated [[MAINTAINERS]].  Those that contribute considerable time to improve the Odamex source may be granted full or partial access.
−
** '''trunk''' - bleeding edge development, may not always work
+
−
** '''branches'''
+
−
*** '''stable''' - synchronised with trunk when features mature
+
−
*** '''ogl_hack''' - a half-hearted attempt at accelerating the renderer
+
−
*** other temporary branches may be created or destoryed
+
−
** tags
+
  
−
== Change notification ==
+
Generally, the [[Policy|project manager(s)]] will administrate this access with the guidance of the lead coder(s).  Inactive accounts will tend to get frozen or disabled after a certain length of time.
 +
 
 +
TO DO: How to use Github and download the source. For now you can download the latest version of the source as a zip file under the green button labelled "Clone or download"
 +
 
 +
== How can I be notified when the repository updates? ==
  
 
Any changes to our svn repository are reported in:
 
Any changes to our svn repository are reported in:
−
* [http://odamex.net/changelog The Odamex Changelog]
+
* [http://odamex.net/changelog.php?count=100 The Odamex Changelog]
−
* [[IRC|The Odamex IRC Channel]]
+
* [[IRC|The Odamex IRC Channel]] by the odasvn bot.
  
−
== Guidelines ==
+
== Guidelines for maintainers ==
  
 
* Do
 
* Do
Line 33: Line 30:
 
** Separate your commits semantically
 
** Separate your commits semantically
 
** Make an informative comment with each commit
 
** Make an informative comment with each commit
−
** Mention related bugs and revisions (see [http://odamex.net/changelog changelog] for format)
+
** Mention related bugs and revisions (see [http://odamex.net/changelog.php?count=100 changelog] for examples)
 +
** Seek comments on bugzilla and forum before making major changes
 +
** Test your changes before every commit
 
* Do not
 
* Do not
 
** Commit broken code to trunk or stable
 
** Commit broken code to trunk or stable
 
** Commit untested code to stable
 
** Commit untested code to stable
−
** Commit giant monolithic commits
+
** Make giant monolithic commits
 +
** Make major changes without consulting maintainers
 +
** Make frivolous commits
 +
** Overwrite other people's recent work without asking them
 +
** Change EOL modes of files, All files should be LF

Latest revision as of 21:16, 1 May 2018

What is Github?

Github is the current version control repository used to maintain the Odamex source code. In layman's terms, it allows multiple people to be working on the same project at the same time while giving those same people the facilities to recognize collisions between two contributors code.

How do I access Odamex's Github respository?

Odamex's Github repository can be accessed using the following URL: 

https://github.com/odamex/odamex

What is Odamex's Github access policy?

Read-only access to Odamex's Github repository is public, meaning that anyone can checkout the source for their own purposes, including modification and compilation. However, further repository access, such as Commit access, is restricted based on our Policy. If you wish to contribute to Odamex, please send a patch to one of the indicated MAINTAINERS. Those that contribute considerable time to improve the Odamex source may be granted full or partial access.

Generally, the project manager(s) will administrate this access with the guidance of the lead coder(s). Inactive accounts will tend to get frozen or disabled after a certain length of time.

TO DO: How to use Github and download the source. For now you can download the latest version of the source as a zip file under the green button labelled "Clone or download"

How can I be notified when the repository updates?

Any changes to our svn repository are reported in:

Guidelines for maintainers

  • Do
    • Regularly update your working copy
    • Commit individual improvements and corrections to the existing code
    • Separate your commits semantically
    • Make an informative comment with each commit
    • Mention related bugs and revisions (see changelog for examples)
    • Seek comments on bugzilla and forum before making major changes
    • Test your changes before every commit
  • Do not
    • Commit broken code to trunk or stable
    • Commit untested code to stable
    • Make giant monolithic commits
    • Make major changes without consulting maintainers
    • Make frivolous commits
    • Overwrite other people's recent work without asking them
    • Change EOL modes of files, All files should be LF
Retrieved from "https://odamex.net/w/index.php?title=Subversion&oldid=3861"