Skip to content

Doc: Implement a global PR template incorporating the team's requested changes to improve documentation#2

Merged
zikani03 merged 7 commits intomainfrom
doc/add-global-pr-template-with-doc-support
Jan 9, 2026
Merged

Doc: Implement a global PR template incorporating the team's requested changes to improve documentation#2
zikani03 merged 7 commits intomainfrom
doc/add-global-pr-template-with-doc-support

Conversation

@meddhiakassab
Copy link
Member

@meddhiakassab meddhiakassab commented Nov 30, 2025

Description

Adds a global pull request template to standardize PR descriptions, types, related issues, demos, and checklists across the team.

Requested changes from @weilu have been added (openimis/openimis-be_py#363) , Pull requests that were previously created for adding individual templates have been closed, as they are no longer ready for review.

The issue form is disabled; the Issues tab in repositories will no longer be used, as OpenIMIS developers and reporters are using Atlassian products for issue tracking.

This template will work with any repository under the OpenIMIS organization, ensuring clear and consistent documentation for all changes.

Demo showing the closing of batches of legacy OpenIMIS documentation pull requests

demo-close-batch-doc-openimis-prs.mp4

@meddhiakassab meddhiakassab self-assigned this Nov 30, 2025
@meddhiakassab meddhiakassab added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 30, 2025
Copy link
Contributor

@zikani03 zikani03 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks okay. Though, I don't know what we can do about the example issue numbers since they may trigger Github to link to actual issues/prs if those numbers exist.

Maybe consider #NNN ?


A clear, concise description of the change. Why is it needed? What problem does it solve?

Motivation ?
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider remove, as the questions above already cover this.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding this to the top will be a nice message for contributor:

#Thank you for your contribution to openIMIS!
#Please complete the sections below. Anything in comments is guidance and can be deleted.

@ajinkyagadewar ajinkyagadewar self-requested a review December 5, 2025 05:23
Copy link

@ajinkyagadewar ajinkyagadewar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added some comments.


A clear, concise description of the change. Why is it needed? What problem does it solve?

Motivation ?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding this to the top will be a nice message for contributor:

#Thank you for your contribution to openIMIS!
#Please complete the sections below. Anything in comments is guidance and can be deleted.

Copy link
Member

@delcroip delcroip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall there is good intentions but I think it is important to focus on area that are critical, please remember that only few org are creating PR outside contractual link with GIZ/WB (SwissTPH, YNote) making the process too annoying will simply lead to no one creating PR outside contract obligations

@zikani03
Copy link
Contributor

zikani03 commented Dec 5, 2025

@ajinkyagadewar we agreed during the call to try to keep the template lean and not overburden contributors when opening PRs. Maybe those other fields can be written as a recommendation elsewhere instead of this template to avoid bloating it?

@meddhiakassab meddhiakassab requested a review from weilu December 19, 2025 09:17
Copy link

@weilu weilu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@meddhiakassab there are still two comments that remain unaddressed.

Copy link
Contributor

@zikani03 zikani03 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@meddhiakassab please address the remaining comments from Wei

chore: removing motivation as already covered by questions above
@zikani03 zikani03 merged commit c3fca07 into main Jan 9, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants