Savane - Cookbook: recipe #121, Contribution Guidelines

recipe #121: Contribution Guidelines

While we want to encourage you to submit code contributions and patches to Savane, we do need to make sure they are cleanly implemented, make sense in the way they are designed and are consistent with the rest of the software.

• 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 #122 and the Securing the Code recipe #259.

When designing your changes, think about a few things:

• Is this legal? You absolutely need to add copyright and licence details in each file you include.
• 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?
• Is it commented? Did you add simple comments throughout your code explaining why/how you're approaching the task?

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.

 

 

 

 

 

Audience and Context

Audience:
   Anonymous Users, Logged-in Users
Feature:
   Source Code Manager: Subversion Repositories
Action:
   Browsing