1450-Add Contrib First documentation. #1451

swirtSJW · 2024-10-17T19:09:56Z

#1450

📚 Documentation preview 📚: https://civicactions-handbook--1451.org.readthedocs.build/en/1451/

github-actions · 2024-10-17T19:10:10Z

Potential file addition - missing nav update

There appear to be new files added in this pull request, but the mkdocs.yml nav has not been modified.
If pages were added, please edit mkdocs.yml to add the new page to the menu.
If not, feel free to ignore this message.

common-practices-tools/contribution/contrib-first.md

swirtSJW

Adjustments made

common-practices-tools/contribution/contrib-first.md

dmundra

Looks great @swirtSJW. Thank you

swirtSJW · 2024-10-17T22:00:36Z

@dmundra Sorry. Can you take another look? I added two new sections.

common-practices-tools/contribution/contrib-first.md

andyhawks

👍

common-practices-tools/contribution/contrib-first.md

grugnog · 2024-10-21T19:43:57Z

common-practices-tools/contribution/contrib-first.md

+-   **Avoiding the gift that never happens** - Clients are not typically supportive of taking working local software that was already built for them and in use by them and then paying to move or refactor that software to be open source. The benefit is too small for the cost. By building it as contributed code first, there is no extra cost.
+-   **Development happens in the open** - The issue are public. The commits are public. Everyone can contribute.
+
+## Contrib first patches


This is pretty Drupal specific language - it would be nice to write this in more general terms (using Drupal as an example, or translating terms etc) as contribution to all the many FOSS projects we use should be our goal.

Good point. It does make a fare amount of assumptions related to Drupal. I wanted this to be the reference specifically for Drupal that I could point to, mainly because the whole issue queue and contrib credit does not really exist elsewhere. What if doubled down on making this one section Drupal specific and then added another section that was more agnostic for other FOSS contributions?

I think that would work!

common-practices-tools/contribution/contrib-first.md

dmundra

@swirtSJW sorry I noticed some things that need updating related to linting and markdown (frontmatter comments). Also remembered some useful additions like non-Drupal examples and links.

practice-areas/engineering/drupal/drupal-contrib-first-module-development.md

...ce-areas/engineering/drupal/drupal-developer-tips-for-getting-the-most-out-of-open-source.md

practice-areas/engineering/drupal/drupal-contrib-first-module-development.md

common-practices-tools/contribution/contrib-first.md

practice-areas/engineering/drupal/drupal-contrib-first-module-development.md

grugnog · 2024-10-22T18:02:33Z

common-practices-tools/contribution/contrib-first.md

+## Rationale for contrib first
+
+-   **Fiscal responsibility** - Building it and contributing it means that other government agencies will never have to pay to build the same thing twice. This helps agencies comply with Federal Source Code Policy: Achieving Efficiency, Transparency, and Innovation through Reusable and Open Source Software [OMB Memorandum M-16-21](https://obamawhitehouse.archives.gov/sites/default/files/omb/memoranda/2016/m_16_21.pdf)
+-   **Reusability** - CivcActions other clients can benefit from work that was already done.


Typo - should be CivicActions

grugnog · 2024-10-22T18:04:18Z

common-practices-tools/contribution/contrib-first.md

+## Rationale for contrib first
+
+-   **Fiscal responsibility** - Building it and contributing it means that other government agencies will never have to pay to build the same thing twice. This helps agencies comply with Federal Source Code Policy: Achieving Efficiency, Transparency, and Innovation through Reusable and Open Source Software [OMB Memorandum M-16-21](https://obamawhitehouse.archives.gov/sites/default/files/omb/memoranda/2016/m_16_21.pdf)
+-   **Reusability** - CivcActions other clients can benefit from work that was already done.


What about broadening this to non-federal, non-CivicActions users - e.g. "CivicActions other clients and the public at large can benefit"

Nice. Done.

grugnog · 2024-10-22T18:10:43Z

common-practices-tools/contribution/contrib-first.md

+
+-   **Fiscal responsibility** - Building it and contributing it means that other government agencies will never have to pay to build the same thing twice. This helps agencies comply with Federal Source Code Policy: Achieving Efficiency, Transparency, and Innovation through Reusable and Open Source Software [OMB Memorandum M-16-21](https://obamawhitehouse.archives.gov/sites/default/files/omb/memoranda/2016/m_16_21.pdf)
+-   **Reusability** - CivcActions other clients can benefit from work that was already done.
+-   **Security** - contributing our work to an open source project like Drupal means it may receive security coverage by the Drupal security team and the public.


Security coverage (at least in terms of Drupal) doesn't actually lead to detection of any new security issues - it's focus is really only on coordinating fixes (completed by project maintainers) for issues that are reported by external users and then notifying other users.
This is a benefit of course, but I am not sure it necessarily adds security on it's own. I would consider starting out with the "many eyes" argument. Essentially, by having many users it's more likely that security vulnerabilities will be detected over time (if it remains private, this is much less likely). Combining this with vulnerability reporting/notification infrastructure (like Drupal, but NVD is also a great example) you get the benefit of a more secure site with minimal additional effort.

I adjusted this to include that.

dmundra

Thank you @swirtSJW

The requested changes have been made.

for more information, see https://pre-commit.ci

swirtSJW requested a review from a team as a code owner October 17, 2024 19:09

swirtSJW requested a review from a team as a code owner October 17, 2024 19:21

dmundra reviewed Oct 17, 2024

View reviewed changes

common-practices-tools/contribution/contrib-first.md Outdated Show resolved Hide resolved

dmundra reviewed Oct 17, 2024

View reviewed changes

common-practices-tools/contribution/contrib-first.md Outdated Show resolved Hide resolved

swirtSJW changed the title ~~1450-Add Contrig First documentation.~~ 1450-Add Contrib First documentation. Oct 17, 2024

swirtSJW commented Oct 17, 2024

View reviewed changes

common-practices-tools/contribution/contrib-first.md Outdated Show resolved Hide resolved

common-practices-tools/contribution/contrib-first.md Outdated Show resolved Hide resolved

common-practices-tools/contribution/contrib-first.md Show resolved Hide resolved

dmundra approved these changes Oct 17, 2024

View reviewed changes

dmundra reviewed Oct 17, 2024

View reviewed changes

common-practices-tools/contribution/contrib-first.md Outdated Show resolved Hide resolved

swirtSJW requested review from andyhawks, grugnog and llanford October 17, 2024 22:29

swirtSJW force-pushed the 1450-Add-contrib-first branch from 2c6bd98 to d6cdc56 Compare October 21, 2024 16:23

andyhawks approved these changes Oct 21, 2024

View reviewed changes

swirtSJW commented Oct 21, 2024

View reviewed changes

common-practices-tools/contribution/contrib-first.md Outdated Show resolved Hide resolved

grugnog reviewed Oct 21, 2024

View reviewed changes

swirtSJW force-pushed the 1450-Add-contrib-first branch from 502d214 to 0fb1326 Compare October 22, 2024 16:24

dmundra requested changes Oct 22, 2024

View reviewed changes

grugnog previously requested changes Oct 22, 2024

View reviewed changes

swirtSJW force-pushed the 1450-Add-contrib-first branch from 2f3e59c to 2d49f39 Compare October 22, 2024 19:15

dmundra requested review from grugnog and dmundra October 22, 2024 23:10

dmundra approved these changes Oct 22, 2024

View reviewed changes

swirtSJW force-pushed the 1450-Add-contrib-first branch from 1216b50 to 9e32d83 Compare October 25, 2024 20:10

Steve Wirt and others added 4 commits October 25, 2024 16:19

1450-Add Contrig First documentation.

3daf75c

Add link.

5560bc0

Add mkdocs menu item.

f2e462e

Apply suggestions from code review

95fac68

swirtSJW and others added 5 commits October 25, 2024 16:19

Add module and patch contributions

291313d

Add link to practice area directions.

8800f13

Add link to composer-patches plugin.

fbbcfa9

Break content out into engineering specific places.

bad11cb

Adding non Drupal examples and clearer language.

7f0532d

swirtSJW force-pushed the 1450-Add-contrib-first branch 2 times, most recently from 1d6e550 to 5fa0ed2 Compare October 25, 2024 20:23

Fix duplicate heading.

4920877

swirtSJW force-pushed the 1450-Add-contrib-first branch from 97b43ec to 4920877 Compare October 25, 2024 20:30

[pre-commit.ci] auto fixes from pre-commit.com hooks

fbadc1b

for more information, see https://pre-commit.ci

swirtSJW merged commit 6b189f2 into master Oct 25, 2024
13 checks passed

swirtSJW deleted the 1450-Add-contrib-first branch October 25, 2024 20:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

1450-Add Contrib First documentation. #1451

1450-Add Contrib First documentation. #1451

swirtSJW commented Oct 17, 2024 •

edited by github-actions bot

Loading

github-actions bot commented Oct 17, 2024

swirtSJW left a comment

dmundra left a comment

swirtSJW commented Oct 17, 2024

andyhawks left a comment

grugnog Oct 21, 2024

swirtSJW Oct 21, 2024

grugnog Oct 21, 2024

dmundra left a comment

grugnog Oct 22, 2024

swirtSJW Oct 22, 2024

grugnog Oct 22, 2024

swirtSJW Oct 22, 2024

grugnog Oct 22, 2024

swirtSJW Oct 22, 2024

dmundra left a comment

1450-Add Contrib First documentation. #1451

1450-Add Contrib First documentation. #1451

Conversation

swirtSJW commented Oct 17, 2024 • edited by github-actions bot Loading

github-actions bot commented Oct 17, 2024

swirtSJW left a comment

Choose a reason for hiding this comment

dmundra left a comment

Choose a reason for hiding this comment

swirtSJW commented Oct 17, 2024

andyhawks left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dmundra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dmundra left a comment

Choose a reason for hiding this comment

swirtSJW commented Oct 17, 2024 •

edited by github-actions bot

Loading