Contributing code
From Seeks
Seeks uses git as a version control system.
Repositories
Seeks main git repository is here:
git://seeks.git.sourceforge.net/gitroot/seeks/seeks
Code can be browsed here.
Developing a contribution
We recommend that you develop using a clone of Seeks' main git repository. Be careful when coding, do not add code that is not under an appropriate licence.
Seeks uses a GNU style indentation. We recommend you use 'astyle'. With 'astyle' Seeks' code indentation is obtained with
astyle --style=gnu --indent-namespaces --indent-classes
We recommend you add indentation formatting to your git 'pre-commit' hook (in your .git/hook repository).
pre-commit is an example of a 'pre-commit' hook for this purpose. Don't forget to 'chmod +x' the pre-commit file!
Submitting a contribution
Contributors have two options for submitting code to Seeks:
- By filling up a redmine ticket and attaching either a pointer to a git repository or patch. [Preferred]
- Submitting patches to the mailing list.
Don't forget to sign the CLA if you intend to submit code to Seeks.
It would save us time if you prepare your code with the Seeks Free Software header:
/** * This file is part of the SEEKS project. * Copyright (C) 2011 <your_name> <your_email_address> * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. */
Replace <your_name> and <your_email_address> with appropriate values.
