URL:
<http://gna.org/cookbook/?func=detailitem&item_id=121>
Summary/Question: Contribution Guidelines
Project: Savane
Submitted by: yeupou
Submitted on: vendredi 25.11.2005 à 11:23
Category: None
Importance: 3 - Normal
Status: Approved
Privacy: Public
Assigned to: None
Open/Closed: Open
_______________________________________________________
Details:
While we want to encourage you to submit code contributions and patches to
Savane, we do need to make sure they are cleanly implemented and make sense
in the way they are designed.
Firstly, read README when it exists in the directory you are working. Almost
every recommandations for specific parts of the code are in README. For
instance, if you modify a CSS file, read the css/README.
Secondly, read the Coding style recipe #??? and the Securing the code recipe
#???. And if you were granted SVN access, it is mandatory that you read the
SVN usage recipe #???.
When designing your changes, think about a few things:
<ul><li>Is this legal? You absolutely need to add copyright and licence
details in each file you include. </li><li>Is this scalable? For example, if
you want to have a pop-up box listing groups or users, that obviously would
never scale. It might work great if you have 10 projects on your test version
of savannah, but what happens when you have 10,000?</li><li>Is it commented?
Did you add simple comments throughout your code explaining why/how you're
approaching the task?</li>
When you prepare your patches, make sure they are tested and known to work,
and make sure that each patch handles basically one feature at a time. If you
group a bunch of features into a single patch, we may not be able to accept
them all, or all at the same time.
_______________________________________________________
Reply to this item at:
<http://gna.org/cookbook/?func=detailitem&item_id=121>
_______________________________________________
Message posté via/par Gna!
http://gna.org/
_______________________________________________
Savane-dev mailing list
[email protected]
https://mail.gna.org/listinfo/savane-dev
