1. Summary
  2. Files
  3. Support
  4. Report Spam
  5. Create account
  6. Log in

Changes between Version 1 and Version 2 of Get started with your new project

01/15/09 19:17:41 (5 years ago)
travis-w (IP:



  • Get started with your new project

    v1 v2  
     1= Get started with your new project = 
     2This documentation is intended for project administrators. Registered !SourceForge.net [http://sourceforge.net/account/newuser_emailverify.php  users] can [http://sourceforge.net/register/ register] their Open Source software development project for hosting on !SourceForge.net. 
     4After a project has been approved, project administrator should: 
     5 1. Determine the goals of your project. 
     6 1. Set up a basic [wiki:"Project web" project web site] or wiki describing the project's goals and intended features. 
     7 1. Ensure that you have selected the [wiki:Trove] categories that describe your project.  Trove categories are displayed on the project summary page and are used to place projects in the [http://sourceforge.net/softwaremap/ Software Map]. 
     8 1. Familiarize yourself with the !SourceForge.net site. !SourceForge.net offers a [wiki:"Comprehensive service directory" variety of services], documented within the !SourceForge.net [wiki:WikiStart Site Documentation]. 
     9 1. Build and [wiki:"Release files for download" release] a working software prototype, which other developers can collaborate with you to improve. 
     11= Administrator responsibilities = 
     12Project administrators have many responsibilities: 
     13 * Responding to inquiries from the project team and coordinating support for the userbase. 
     14 * Regular [wiki:"Backup your data" backups] of project data. 
     15 *  Removing unused date from the [wiki:"Project web" project web space] and associated [wiki:"Project database" databases]. 
     16 * Ensure the project complies with the [http://www.sf.net/docs/definition.html OSI Open Source Definition] and the !SourceForge.net [https://apps.sourceforge.net/trac/sitelegal/wiki/Terms%20of%20Use Terms of Use] 
     17 * Provide a timely response to inquiries from !SourceForge.net [wiki:"Get support from SourceForge.net staff" staff]. 
     18 * Keep apprised of [https://sourceforge.net/community/forum/forum.php?id=11&page SourceForge.net Site Status] 
     20= Recruiting new developers = 
     21The administrators of each !SourceForge.net project work in partnership to manage development and control of project resources. To allow project activity to continue in the absence of a single person, like when you go on vacation, we encourage all projects to have at least two administrators. Project administrators can speak for the project and contact !SourceForge.net staff for assistance. Get to know candidates for administrator prior tto adding them to your project team. 
     23!SourceForge.net provides two ways to help you recruit new project members: the Project Help Wanted page, and a [[http://sourceforge.net/forum/forum.php?forum_id=710|discussion forum]] for projects seeking developers. The project [[http://sourceforge.net/people/|Help Wanted]] page allows projects announce openings for volunteers in their development team, or to request assistance with specific technical problems. As a project administrator, you may [[Administration#helpwanted|post jobs]] to the Help Wanted system, and edit jobs you previously posted. Jobs posted to the Help Wanted system are mentioned on the project Summary Page. 
     27= Permissions = 
     28Permissions to use and modify project resources are set by project administrators. A user must be [[Administration#adduser|added]] the project membership before they can be [[Administration#userpermedit|granted explicit permissions]] over project resources. !SourceForge.net uses a MAC-based (Mandatory Access Control) permissions system; administrative control over project resources is granted per resource and per developer. 
     30Permissions system keywords: 
     32* **Project Role:** Allows a project member to have a purely cosmetic description of what they do 
     33* **Project Admin:** Allows a project member complete control over a project and speak on behalf of the project. 
     34* **Allow access to shell server group space:** Allows access to project web and other group-specific content on the project shell server 
     35* **Allow access to CVS repository:** Allows access to the project CVS repository. Fine grained access permissions can be controlled using the [[CVS - Version Control for Source Code#permissions|cvs_acls]] 
     36* **Feature Permissions:** Allows project members to manage the feature without having full administrative control. Each !SourceForge.net feature provides some level of administrative control that can be delegated to project members 
     39Feature Permissions: 
     41* Admin/Manager/Editors: Can configure a feature and manage feature data 
     42* Technician: Can be assigned items (tasks, tracker items, etc.) 
     43* Moderator: Can manage visibility of message posts (i.e. hide a Mailing List or Forum post) 
     46Common administrative actions include: 
     48* [[Administration#useradd|Add a Project Developer]] 
     49* [[Administration#userpermedit|Change a user's permissions]] 
     50* [[userremove|Remove a user or administrator from a project]] 
     53=Add a Project Developer= 
     54Developers are the cornerstone of any successful Open Source Software project. We recommend that each project try to maintain a sufficiently large developer base to maintain development momentum, especially in the absence of some of the developers. 
     56However, adding a user to a project is a major action with potentially serious consequences. The user will have access to project resource and content. There is a potential risk that the user could cause harm to the project. Before adding a user, weigh all the potential risks against the benefits. 
     58Only a project administrator can add a developer or admin to a project: 
     60# Log into the !SourceForge.net website 
     61# Go to the project's summary page (https://www.sf.net/projects/PROJECTNAME/) 
     62# Click on the project 'Admin' link 
     63# Click on the 'Members' link 
     64# Click on the 'Add a developer to this project' link 
     65# Type in the developer's user name into the 'UNIX name' box and click the 'Add user' button 
     66# Select the proper permissions for the user, as documented in the [[Administration#permslist|Permissions Overview]] 
     67# Click on the 'Update Developer Permissions' button 
     70Should a project not have an admin to add a user, an [[Administration#takeover|Abandoned Project Takeover]] should be submitted. 
     72= Managing developer permissions = 
     73A list of developer permissions is located in the [[Administration#permslist|Permissions Overview]]. Permissions only exist for [[Administration#useradd|project developers]] and can only be modified by a project administrator. 
     75To modify the permissions of a developer: 
     77# Log into the !SourceForge.net website 
     78# Go to the project's summary page (https://www.sf.net/projects/PROJECTNAME/) 
     79# Click on the project 'Admin' link 
     80# Click on the 'Members' link 
     81# Click on the username of the user whose permissions you wish to modify 
     82# Changed the permissions as desired 
     83# Click on the 'Update Developer Permissions' button 
     86= Remove a developer = 
     87To remove a developer or project admin from a project: 
     89# Log into the !SourceForge.net website 
     90# Go to the project's summary page (https://www.sf.net/projects/PROJECTNAME/) 
     91# Click on the project 'Admin' link 
     92# Click on the 'Members' link 
     93# Click on the username of the user to remove 
     94# If checked, uncheck the 'Project Admin' checkbox 
     95# Click on the 'Update Developer Permissions' button 
     96# Click on the 'Members' link 
     97# Click on the trashcan icon to the left of the user to be removed 
     98# Comfirm the removal by clicking on the 'Remove' button 
     101= Help Wanted = 
     102The Help Wanted system allows projects to advertise open positions for volunteers. This is similar to the jobs section of a newspaper. Projects define the necessary skill and a description of the job opening. Site users may review Help Wanted ads and find a project that needs their help. 
     104To create a new Help Wanted ad: 
     106# Log into the !SourceForge.net website 
     107# Go to the project's summary page (https://www.sf.net/projects/PROJECTNAME/) 
     108# Click on the project 'Admin' link 
     109# Click on the 'Recruitment' link 
     110# Click on the 'Post Jobs' link 
     111# Fill out the Create a New Job form and click the 'Continue >>' button 
     112# Add the required skills with the minimal level and experience required, and click on the 'Add Skill' button for each time a new skill is to be added 
     113# Click on the 'Finished' button 
     116To edit a previously posted Help Wanted ad: 
     118# Log into the !SourceForge.net website 
     119# Go to the project's summary page (https://www.sf.net/projects/PROJECTNAME/) 
     120# Click on the project 'Admin' link 
     121# Click on the 'Recruitment' link 
     122# Click on the 'Edit previously posed jobs' link 
     123# Click on the title of the job to edit 
     124# Click on the 'Edit Job' link 
     125# Modify the job as desired and click on the 'Finished' button 
     128Jobs posted to the Help Wanted system are automatically closed after two weeks. Please keep a local copy (i.e. in a text file or similar) of your job postings, as copies of this data is not generally retained by the !SourceForge.net system. 
     130=Preferred Support Mechanism= 
     131!SourceForge.net provides many different tools to projects, including Trackers, Mailing Lists, Forums, direct email, etc. The Preferred Support Mechanism setting allows a project to define how they want users to contact them. 
     133The 'Get Support' link on the left navbar of the !SourceForge.net website will provide information about the Preferred Support Mechanism for a project. If the Preferred Support Mechanism isn't configured, a listing of project resources is shown instead. 
     135To set the Preferred Support Mechanism: 
     137# Log into the !SourceForge.net website 
     138# Go to the project's summary page (https://www.sf.net/projects/PROJECTNAME/) 
     139# Click on the project 'Admin' link 
     140# Click on the 'Public Info' link 
     141# Click on the '[Set Preferred Support Mechanism]' link 
     142# Select the Preferred Support Mechanism from the provided list 
     143# Click on the 'Set Preferred Support Mechanism' button 
     146=Feature and Service Management= 
     147Site Documentation is provided on all !SourceForge.net features. For specifics in the administration and use of a particular tool or feature, refer to its documentation: 
     149* [[Tracker - Bug Reporting, Support Requests, Feature Requests, Patches#top|Tracker]] 
     150* [[Document Management, Content Management#top|DocManager]] 
     151* [[Screenshots#top|Screenshots]] 
     152* [[Mailing List Management#top|Mailing Lists]] 
     153* [[Discussion Forums#top|Discussion Forums]] 
     154* [[Project Web, Shell, VHOST and Database Services#top|Project Shell Server]] 
     155* [[Project Web, Shell, VHOST and Database Services#mysql|Project Database Service]] 
     156* [[Project Web, Shell, VHOST and Database Services#top|Project Web Service]] 
     157* [[CVS - Version Control for Source Code#top|CVS]] 
     158* [[Statistics#top|Statistics]] 
     159* [[File Release System - Offering Files for Download#top|File Release System]] 
     160* [[Donation System#top|Donations]] 
     163To disable a feature or service: 
     164* Uncheck the enable service checkbox on the service-specific project admin page 
     165* Change the visibility the feature instance deleted, hidden or private. Private resources are available only to project members 
     168Details regarding removal of data from a !SourceForge.net may be found in our guide to [[Data Preservation Policy, Data Removal Instructions#top|Data Preservation and Removal]]. 
     170=Trove Categorization= 
     171The Trove is a means to convey basic meta-information about your project. Information about your project stored within the Trove is available via your Project Summary page, in [[http://sourceforge.net/search/|search results]] and the [[http://sourceforge.net/softwaremap/|Software Map]]. It is important to categorize your project within the Trove, because this is one of the primary ways that !SourceForge.net site users will find out about your project. 
     173Trove data essentially breaks down into two categories: project goals and software details. A project should be categorized in as many specific categories that apply. 
     175The meaning of each Trove category entry is subject to interpretation; we don't define what any entry means in order to allow each project to use it as they desire. However, setting a value to categories above or beyond what the project's status is, can be detremental to their development efforts. 
     177To set or modify the Trove categorization: 
     178# Login to the !SourceForge.net website 
     179# Go to the project summary page (https://www.sf.net/projects/PROJECTNAME) 
     180# Click on the 'Admin' link 
     181# Click on the 'Public Info' link 
     182# Click on the '[Edit Trove Categorization]' link 
     183# Add or Remove Trove entries as desired 
     186Changes to the Trove categorization take effect immediately. Clicking on the Add or Remove button will make the change live, there is no other 'Submit' button that will need to be pressed. 
     188=Descriptive Name Change= 
     189The project descriptive name is used to identify the project where a full project description would be too long. Generally, it is also easier to remember than the project UNIX name by end users, and is also used to help generate search results. 
     191To change the project descriptive name: 
     192# Log into the !SourceForge.net website 
     193# Go to the project's summary page (https://www.sf.net/projects/PROJECTNAME/) 
     194# Click on the project 'Admin' link 
     195# Click on the 'Public Info' link 
     196# Modify the value in the 'Project Descriptive Name:' text box 
     197# Click the 'Update' button 
     200=Changing Project License Terms= 
     201To change the license terms of your software: 
     203# Determine whether you may legally change the license. If you have been the sole developer, there should be nothing stopping you from doing so. Otherwise we recommend that you speak with a lawyer to discuss the change, permission from past developers may be necessary. Special limitations may also be imposed by other software linked to your code. Not all licenses are compatible. !SourceForge.net staff cannot provide legal advice. 
     204# Pick a replacement license that meets the [[http://www.opensource.org/docs/definition.html|Open Source Definition]]. All content on !SourceForge.net must meet the terms of the Open Source Definition. 
     205# If you do not choose an [[http://www.opensource.org/licenses|OSI-approved Open Source license]], you must submit a [[Administration#support|Support Request]] to obtain approval of your license choice. 
     206# Update the [[Administration#trove|Trove categorization]] to reflect the new license choice. 
     207# Update the licensing terms listed in your project web content, documentation and new releases. 
     210It is also important to realize that the license on existing source code releases may not be changed. You may only change the license on new releases, or re-release your existing code under a new license. Once Open Source software has been released under a particular license, the use of that version of the software may continue under the license used at that time, even if the project moves to a new license for future releases. 
     213Projects can get publicity through the use of several different site features: 
     215* [[Project News#top|Project News]]: Allows users to see on the project summary page project progress that is noteworthy. Further, posted news may get listed on the !SourceForge.net front page and distributed with the weekly newsletter. 
     216* [[File Release System - Offering Files for Download#top|File Release System]]: Allows users to download binary and source archives of your software. The site has a list of recently released files and some users may be monitoring your project for new releases. This is key to getting and maintaining a captive audience. 
     217* [[http://www.freshmeat.net|Freshmeat.net]]: Allows projects to advertise their existence on the Web's largest index of cross-platform software, themes and related "eye-candy", and Palm OS software. 
     218* [[Administration#trove|Trove Categorization]]: Allows a project to be visible within the [[http://sourceforge.net/softwaremap/|Software Map]]. This provides powerful filtering and other features for projects. 
     219* [[Project Web, Shell, VHOST and Database Services#top|Project Web]]: Allows a project to advertise their software in ways not possible with other features. Web services are provided to all projects hosted at !SourceForge.net. 
     222=Project Takeover= 
     223There are two types of takeovers: 
     224* Those that wish to continue an existing project's development 
     225* Those that want to delete the existing project to reuse the name for another purpose. 
     228Projects without an active administrator can be handed off to another user. This allows for a stagnant project's development to continue. In this case, a project's data stays intact. 
     230A project that was never active is subject to removal. A user can request the re-use of an inactive project. Upon verification, the existing project is removed and the namespace freed for future development. 
     232In either case, to request a takeover, [[Starting a New Project#top|submit a new project registration]] using the same UNIX name as the existing project. The project registration process will then handle the request accordingly. 
     234=UNIX Name Change= 
     235A project's UNIX name can be changed. This process may not, however, move all data. To change your project's UNIX name: 
     237# Select the 'Public Info' link from the 'Admin' dropdown menu. 
     238# Select the 'self service rename request' link. 
     239# Follow the instructions on the resulting page to submit a rename request for your project. 
     242= Getting Help = 
     243 * [wiki:"Support"] 
     244 * [wiki:"Request an enhancement"]