Changes between Version 7 and Version 8 of Development


Ignore:
Timestamp:
Mar 5, 2010 3:02:09 PM (5 years ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Development

    v7 v8  
    2020svn checkout https://svn.yam.ch/svn/yam/trunk yam 
    2121}}} 
     22This will checkout the sources from our 'trunk' to a local directory 'yam' on your hard disk. 
    2223 
    23 This will checkout the sources from our 'trunk' to a local directory 'yam' on your hard disk.  
    24  
    25 '''WARNING:'''[[BR]] 
    26 As usual, it is '''not''' guaranteed in any way, that the 'trunk' version will work for you properly. The 'trunk' of a SVN repository is always meant to carry highly experimental code which is not meant to be used on normal productive systems. It may break your current installation and may destroy data stored on your harddisks. On the other hand, downgrading may cause the same effect. And, maybe you will have to update your configuration files and/or images files aswell, which are probably not directly available through SVN. Please be always aware of that when you want to compile YAM yourself. 
     24'''WARNING:'''[[BR]] As usual, it is '''not''' guaranteed in any way, that the 'trunk' version will work for you properly. The 'trunk' of a SVN repository is always meant to carry highly experimental code which is not meant to be used on normal productive systems. It may break your current installation and may destroy data stored on your harddisks. On the other hand, downgrading may cause the same effect. And, maybe you will have to update your configuration files and/or images files aswell, which are probably not directly available through SVN. Please be always aware of that when you want to compile YAM yourself. 
    2725 
    2826== Developer SVN access == 
     
    3230svn checkout https://svn.yam.ch/svn/yam/trunk yam 
    3331}}} 
    34  
    3532However, for writing changes back to the repository, you have to use the 'commit' command of SVN. 
    3633 
     
    3936svn commit 
    4037}}} 
    41  
    4238Similar to the above anonymous SVN description, the update of an already checked out version of the YAM sources can be update with: 
    4339 
     
    4642svn update 
    4743}}} 
     44 
     45== Submit your change == 
     46There are several ways you can contribute to the YAM development. As the first steps you should: 
     47 
     48'''1. Get the code.''' 
     49Install a  [wiki:NightlyBuild nightly build] and do an anonymous SVN checkout. 
     50 
     51'''2. Find a bug to solve or a feature to implement.''' 
     52If you decide to implement a new feature, it might be worth discussing this in the developer [http://www.yam.ch/18.html mailing list] mailing list first, to test water, get feedback from lead developers and see if anybody is already working on it, or if it fits at all into the general direction of the project. 
     53 
     54'''3.  Submit a patch.''' 
     55There are generally two ways to do a  patch. You could make a copy of file you edit beforehand, and create a  patch with: 
     56 
     57{{{ 
     58diff -u file.c.orig file.c > file.c.patch 
     59}}} 
     60 
     61or do it with SVN: 
     62 
     63{{{ 
     64svn diff -u file.c > file.c.patch 
     65}}} 
     66 
     67Submit your patch to the project's [wiki:MailingLists development mailing list]. Please include your patch as a 'text/plain' attachment. Be prepared to be met with a critical analysis of your patch. In case your patch is refused, ask why and either correct your patch or constructively argue your point. In case you receive no feedback, try bumping the issue once after a day or three. If you still do not receive an answer, maybe your patch is not worthwhile. Keep it in case someone raises the issue in the list sometime in the future, but otherwise sleep on it. 
     68 
     69And some general points to remember: 
     70 
     71 * Respect the project coding standards, otherwise your patches will not be committed. You can find the coding standards in the classes subdirectory under [/browser/trunk/src/classes/StyleGuide.ReadMe src/classes/StyleGuide.ReadMe] or directly from SVN. 
     72 * Work within the current framework, that is use the available classes and mechanisms. 
     73 * Monitor the [wiki:MailingLists development mailing lists], the [http://forum.yam.ch/ discussion forum], and those of the apps you work on. 
     74 
     75Lastly, remember that, although you work on the project on your own goodwill, this does not grant you any specific privileges. The lead developers make the final call. Sometimes, they may make decisions that you may not agree with. Obviously, you are entitled to voice your opinion and argue your point, but stay civil, do not drag it out and respect their decisions. 
     76 
     77That is pretty much it. One last thing: do not do it for an ego boost, do it for the love of coding. The unfortunate truth is that contributing to an open source project will most likely never get you the kind of fame Linus Torvalds and friends enjoy, nonetheless, as with any Open Source project, your contribution will be greatly appreciated by the community, especially in the still shrinking Amiga community.