Changes

Jump to: navigation, search

Committing policies

1,398 bytes added, 14:18, 22 March 2022
PR rebase/merge
==Contributing==
 
===Create a bug report, feature request or GEP===
* It is good practice for every change to have a bug report, feature request or [[GEPS|GEP('''G'''ramps '''E'''nhancement '''P'''roposal''')]].
* Fixing a bug in an existing bug report is a good way to start Gramps development.
 
===Discuss the change on the mailing list===
* Allows all developers to reach a consensus on a good design that conforms to our [[Developer_policies|developer policies]].
* Important for new features and changes to the user interface.
* Not necessary for small changes or when the has been sufficient discussion in the bug report.
* Agreeing a design before coding could prevent wasted coding effort.
* If the change is large you may be asked to write a GEP.
 
===Code the change===
* Assign the bug report or feature request to yourself.
* Add the change to the [[5.1_Roadmap|roadmap]] if appropriate.
* Create a GEP branch for large changes.
 
===Create a pull request===
* Unless it’s a trivial change create a PR to get your code reviewed.
* Add a link to the PR in the bug tracker. Use '''p:gramps:nnn:''' where nnn is the PR number.
* Regularly rebase your PR onto the upstream branch. Do not merge branches into your PR.
 
==Branches==
* Only new features should be committed to the master branch.
* Only bug fixes should be committed to maintenance branches.
* The current maintenance branch should be merged regularly into the master branch.
* Translations may be committed to any active the ''gramps51'' branch. Later versions use Weblate, and ''po'' files should not be modified directly.
==Merging==
* The GitHub "Squash and merge" button can be used for most small changes.
* A no-ff merge outside of GitHub should be used when it is useful to keep the commit history.
* Bug fixes must be committed to the current stable branch and cherry-picked to master.
* Only new features should be committed to master directly.
Remember to remove references to the file from the <code>po/POTFILES.in</code> and <code>po/POTFILES.skip</code> files.
 
==See also==
* [[Howto: Contribute to Gramps]]
* [[How you can help]]
[[Category:Developers/General]]
[[Category:How_do_I...|How can I help?]]

Navigation menu