Changes

If you are just writing an addon to contribute, this document adds some context to what comprises an addon ''package''. However, these are'''not''' tasks you will need to do. The tasks described here apply to the <tt>addons</tt> repository primarily, and not so much to the <tt>addons-source</tt> repository, even though they are pretty tightly connected to one another. We assume you are familiar with Gramps addons, git, and github. {{man note|Linux Only|These instructions and the <tt>make.py</tt> script have been built to operate in a Linux development environment. They will not work on Windows or macOS without modifications.}}

{{man note|EDPR submissions in the <tt>addons-source</tt> repository drive the maintenance tasks in <tt>addons</tt>. The only PR submissions to <tt>addons</tt> should be the ones you make as the maintainer. PRs to <tt>addons-source</tt> need to be reviewed periodically. The goal is to make sure that useful changes don't end up sitting too long beforebeing merged. Pay close attention to changes that could impact security and quality. Make sure that the PR is only changing what it must, andhas been submitted against the proper branch. Then, comment on the PR if necessary, or mark it reviewed, and add any labels that may be ofuse (Translations and Work-In-Progress (WIP) are often useful). PRs that continue for a long time as draft or WIP may need to be closed at some point, or the submitter pinged for progress reports. When todo this is a judgement call since not everyone works at the same speed. All of the above can be done via the github web interface, or via the command line using the [https://cli.github.com <tt>gh</tt> tool]. Forexample, to see the current list of open PRs:<pre>$ gh pr list Showing 13 of 13 open pull requests in gramps-project/addons-source ID TITLE BRANCH CREATED AT #733 Translations update from H... weblate:weblate-gram... about 6 days ago#668 Gram.py Refinements dsb/grampy-refinements about 2 months ago#614 created GraphView italian ... SebastianoPistore:gr... about 7 months ago#558 small fix to name all data... loisspitz:translate_... about 2 years ago#540 fix: recast list to tuple ... cdhorn:maintenance/g... about 2 years ago#522 [MediaReport] Allow all ou... Mattkmmr:media-repor... about 3 years ago#477 [GraphView] rewrite theme ... vantu5z:graphview_pe... about 4 years ago#473 Introduce the new Geneanet... bcornec:master about 4 years ago#285 [MediaReport]: New image D... Mattkmmr:update-medi... about 5 years ago#267 Form Gramplet: per Form, p... stevenyoungs:form_ac... about 5 years ago#232 [GraphView] Add drag and d... vantu5z:graphview_dr... about 5 years ago#214 GEPS045 update addons for ... places about 5 years ago#140 [Uncollected Objects]Updat... leakv2 about 7 years ago</pre>Or, to view the details of a PR:<pre>$ gh pr view 668Gram.py Refinements gramps-project/addons-source#668Draft • dsblank wants to merge 1 commit into maintenance/gramps60 from dsb/grampy-refinements • about 2 months ago+27 -1 • No checksAssignees: dsblank   WIP: Updating some items based on feedback from discourse. 1. Be able to iter over NoneData 2. added references 3. added back_references 4. added back_references_recursively   View this pull request on GitHub: https: What do we want //github.com/gramps-project/addons-source/pull/668</pre> At some point, there will be sufficient review and testing to merge the PR -- again, a judgement call will need to be made. It is this merge that triggers most tasks in the <tt>addons</tt> repository. For each addon modified by the merge, the package for it will need to be rebuilt and submitted as a PR to say herethe <tt>addons</tt> repository. Please go through this brief checklist before merging PRs into the maintenance branch in <tt>addons-source</tt>: * Has the PR been reviewed enough? Anything* Have the changes in the PR been tested?* Is the PR targeting the proper maintenance branch?|* Check Will the merge succeed (github does check this for you)?* If this is a new PRs periodicallyaddon, have wiki pages been added describing it? If they have not, wait to do the merge until they have been.* Review for security and qualityFor changes to existing addons, do they clearly state what they fix or add? Have changes been made to the wiki pages to document that?* Test patched codeIf this is a bug fix, does the PR state which bug?* Script Which addons have changed and will need to be repackaged? <!--Would it help to have workflows on github to send notices periodic reminders to PR submitters that their PR still needs work? I'm pretty sure this ispossible. Further, would it be useful to automatically close or deletePRs that have been around too long? If so, how long is too long? PR#140is seven years old, for example. One thought would be to send monthly reminder to PR authors; if there hasbeen NO activity for more than six months, send the PR author a note thatthe PR will be closed without activity?}}merging and can be re-opened if they stillneed it. I'm pretty sure this is possible but I'll have to dig a littlebit to figure out how to automate it.-->