Changes

Jump to: navigation, search

Developer policies

411 bytes added, 01:35, 11 June 2020
Coding policies
[[Category:Developers/General]]This document collects the different policies the GRAMPS Gramps developer community has adopted.
== Coding Policies policies ==
=== Licence ===
GRAMPS Gramps is a GPLv2 licensed application with the possibility to use a later version of the GPL (GPLv3). There are no plans at the moment to move to GPLv3 and drop GPLv2. See [[Project License]] for details.
=== Coding style === GRAMPS follows PEP 8. More info and general policy: Follow the Gramps [[Programming Guidelinesguidelines]]. Starting from 3.2 minimal pylint scores will probably be enforced- which mostly refer to PEP8 with a few additions.
Concerning All source files shall include conforming [[Source file headers]]. === GUI design ===User interfaces shall conform to the visual elements, a general UI style is agreed upon: [[UI Stylestyle]].
=== Acceptable changes ===
You should follow the [[:Category:Developers/Roadmap|roadmap ]] set out for the next release. Only minor features or new reports/gramplets/... can still be added to the roadmap after it has been made official. Add your changes to the [[:Category:Developers/Roadmap|roadmap ]] (on this wiki and in the bug tracker) so others are notified what you work on. Seek approval for your changes via the ''gramps-devel '' mailing list.
== Commit Policies policies ==
=== General ===
Read [[Committing Policiespolicies]]
=== Becoming an official developer ===
The road to become an official developer is as follows:
* Fix bug issues bugs on the bug tracker and participate in the ''gramps-devel '' mailing list. * Accept the guidance from existing developers. If you do not agree with them, you need to convince them. To do that , first consider first to code coding what is asked for and pointing out the weakness afterward, i.e . let the code speak for you.* Take up a feature request after assuring yourself (eg e.g. via the ''gramps-devel '' mailing list), the feature will probably be accepted by the developers. Let your code be reviewed. * Once you come to the conclusion your code needs little change before commit, ask the technical architect (Nick) to send you an invitation to join the GitHub ''Developers'' team. If you have not had contact with the technical architect yet, ask one of the other developers to vouch for you.* Even after you obtained commit rights, consider a review of your code by other developers by submitting a pull request or using the bug tracker (send reminder) or the ''gramps-devel'' mailing list.
[[Category:Once you come to the conclusion your code needs little change before commit, ask one of the admins (Benny, Brian) to add your sourceforge id to the list of developers. If you did not have contact with the admins yet, ask one of the other developers toDevelopers/General]]

Navigation menu