Contributing Source Code to OpenPetra.org: Difference between revisions

From OpenPetra Wiki
Jump to navigation Jump to search
No edit summary
 
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==Tracking of Bugs and Things to do==
==Tracking of Bugs and Things to do==
We are managing the projects, todo lists, feature requests, and bugs all in one place, also called a '''Tracker'''.  
We are managing the projects, todo lists, feature requests, and bugs all in one place, at Github issues.


We use Mantis for tracking of those things. It can be found here: http://tracker.openpetra.org<br />
===Github issues Information===
Everyone can report issues (we will revise that if the spam becomes too much...).
We use Github issues for tracking of those things. You can get there via this link: https://github.com/openpetra/openpetra/issues<br />


===Workflow of bugs and features in Mantis bug tracker ===
'''These issues are ''public'', i.e. everyone with web access can get to it and see the Bugs.''' <br />
Mantis provides the following status codes to keep track of a bug or a feature:<br>
* The fact that the issue tracking system for OpenPetra is public needs to be kept in mind when filing bugs or adding information and attachments and screenshots!
New, feedback, acknowledged, confirmed, assigned, resolved, closed.<br>
The possible values for the next status are shown in the diagram below.


:'''current status: possible next status codes'''
'''Before you record something you think is not working, or does not seem what you think it ought to do, or if the application issues an error dialog, please have a look if someone already posted a similar issue.'''<br>
:*New: feedback, acknowledged, confirmed, assigned, resolved, closed
:*Feedback: acknowledged, confirmed, assigned, resolved, closed
:*Acknowledged: feedback, confirmed, assigned, resolved, closed.
:*Confirmed: feedback, assigned, resolved, closed
:*Assigned: feedback, resolved, closed
:*Resolved: feedback(reopened), assigned, closed
:*Closed: feedback(reopened), assigned, resolved(retest)
 
Bugs that have been resolved should be assigned to the person who reported this bug.<br>
This person can then make sure that the fix is providing the desired functionality. <br>
If this person does not have the skills or equipment to fully test the bugfix, <br>
the bug needs to be passed on to a qualified person within the OpenPetra team, <br>
who then will consult specialists from the business departments if needed. <br>
Bugs that have been reported from outside OM are dealt with in the same way.<br>
 
===Special workflow for features related to the project plan===
The severity of a bug can be set to “feature” declaring it as a feature rather than a bug.<br>
We plan to over the time enter all of the major project plan tasks as features into Mantis. <br>
These features will have the field ProjectPlanID set to its corresponding ID from the main project plan. <br>
 
If an issue is classified as a feature and has been given a ProjectPlanID, a special workflow applies .<br>
Once the feature has reached the status resolved, it should then be moved to a different queue for testing.<br>
This is done by “move issue” in Mantis. There are subprojects provided for testing related to each of the modules.<br>
Moving the feature to one of these subprojects will make it obvious that this issue is ready for testing. <br>
If the test fails, the issue will be reopened which means the status will be set to “feedback”. <br>
The feature remains in the test queue. Once the issue has been successfully tested, it is set to closed<br>
and moved back to its original queue. The original queue can be found in the history of this feature.


''When you file bugs or request features please make sure that you are following our [[Mini-guide for Bug reporting]]!''


==Questions and Discussions==
==Questions and Discussions==
For questions and discussions there are two places where this should happen:
Questions and discussions should happen in the '''Forum'''. It can be found here: [https://forum.openpetra.org/t/developer-area Developer Forum]
* Questions and discussions which should be trackable over time and might lateron shed light on how decisions were made in the project:
** Those discussions should happen in the '''Forum'''. It can be found here: [http://sourceforge.net/apps/phpbb/openpetraorg/viewforum.php?f=3&start=0 Developer Forum]
* Questions and discussions which are about short-lived things or problems and where it isn't necessary to have a record of:
** Those should happen on our '''IRC Channel'''. It can be found on irc.freenode.net in room #OpenPetra
 


==Documentation==
==Documentation==
Line 55: Line 22:
** documents outside the wiki might become forgotten on the local machine of a developer (or on a network drive) and no-one else will have (easy) access to them
** documents outside the wiki might become forgotten on the local machine of a developer (or on a network drive) and no-one else will have (easy) access to them


 
==Contributing Code and Patches==
==Bazaar Source Code Repository and Patches==
See [[Submitting patches and features]] for more information.
* ''Core developers'' have write access to the Bazaar code repository of OpenPetra bzr+ssh://bazaar@bzr.openpetra.org:2208/openpetra/
* ''New developers'' should ask for a mentor. See [[Submitting patches and features]] for more information.
* ''Occasional developers'' need to
# check out the Bazaar repository anonymously from http://bzr.openpetra.org:8008/openpetra/trunk
# create a local branch for themselves for the change. Add a patch to the bug tracker record at http://tracker.openpetra.org/ or add a link to a bazaar branch e.g. at http://launchpad.net/
 


==Copyright of Contributions==
==Copyright of Contributions==
We need to still discuss how we deal with the copyright of contributions. See also the discussion on this blog about [http://blogs.gnome.org/bolsh/2009/04/08/copyright-assignment-and-other-barriers-to-entry/ copyright assignment]. <br />
We need to still discuss how we deal with the copyright of contributions. See also the discussion on this blog about [http://blogs.gnome.org/bolsh/2009/04/08/copyright-assignment-and-other-barriers-to-entry/ copyright assignment]. <br />
Please let us know what you would prefer! OM is a charity, and it might be a good copyright holder to make relicensing easier. But if that is a big problem for you, please let us know, and we can discuss it.
Please let us know what you would prefer! OM is a charity, and it might be a good copyright holder to make relicensing easier. But if that is a big problem for you, please let us know, and we can discuss it.

Latest revision as of 19:33, 4 November 2020

Tracking of Bugs and Things to do

We are managing the projects, todo lists, feature requests, and bugs all in one place, at Github issues.

Github issues Information

We use Github issues for tracking of those things. You can get there via this link: https://github.com/openpetra/openpetra/issues

These issues are public, i.e. everyone with web access can get to it and see the Bugs.

  • The fact that the issue tracking system for OpenPetra is public needs to be kept in mind when filing bugs or adding information and attachments and screenshots!

Before you record something you think is not working, or does not seem what you think it ought to do, or if the application issues an error dialog, please have a look if someone already posted a similar issue.

When you file bugs or request features please make sure that you are following our Mini-guide for Bug reporting!

Questions and Discussions

Questions and discussions should happen in the Forum. It can be found here: Developer Forum

Documentation

  • Technical details of an implementation in OpenPetra should always be documented in this OpenPetra wiki.
  • Do not use documents (of any file format) for documentation of technical details of an implementation in OpenPetra, because
    • the wiki should be the single central source of information about OpenPetra
    • documents in various file formats don't usually have a change history, but the wiki keeps track of the change history
    • documents outside the wiki might become forgotten on the local machine of a developer (or on a network drive) and no-one else will have (easy) access to them

Contributing Code and Patches

See Submitting patches and features for more information.

Copyright of Contributions

We need to still discuss how we deal with the copyright of contributions. See also the discussion on this blog about copyright assignment.
Please let us know what you would prefer! OM is a charity, and it might be a good copyright holder to make relicensing easier. But if that is a big problem for you, please let us know, and we can discuss it.

Retrieved from ‘https://wiki.openpetra.org/index.php?title=Contributing_Source_Code_to_OpenPetra.org&oldid=4864’