Skip to content

Commit

Permalink
[pre-commit.ci] auto fixes from pre-commit.com hooks
Browse files Browse the repository at this point in the history
for more information, see https://pre-commit.ci
  • Loading branch information
pre-commit-ci[bot] committed Oct 22, 2024
1 parent c1794e8 commit 2f3e59c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
6 changes: 3 additions & 3 deletions common-practices-tools/contribution/contrib-first.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Whenever we are building something that could be of use by more than one project
## 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** - CivicActions other clients and the public at large 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. It is made more secure by getting more eyes on the code and more users surfacing any issues.
- **Reusability** - CivicActions other clients and the public at large 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. It is made more secure by getting more eyes on the code and more users surfacing any issues.
- **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 become 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 issues are public. The commits are public. Everyone can contribute improvements.
- **Reliability** - A solution built for contribution is often better designed, and better documented than a local solution meant to "just get it done". By putting our company and personal names on it publicly we commit to a quality product. Releasing a FOSS solution also increases the number of testers and edge cases that can surface and reduce bugs in the code.

Check warning on line 16 in common-practices-tools/contribution/contrib-first.md

View workflow job for this annotation

GitHub Actions / remark-lint-suggestions

[remark-lint-suggestions] common-practices-tools/contribution/contrib-first.md#L16

Unexpected potentially insensitive use of `just`, try not to use it just retext-equality
Raw output
16:137-16:141 warning Unexpected potentially insensitive use of `just`, try not to use it                                    just                  retext-equality
Expand All @@ -24,7 +24,7 @@ Whenever we are building something that could be of use by more than one project
- [Codit: Menu Tools](https://www.drupal.org/project/codit_menu_tools)
- [Content Model & Site Documentation](https://www.drupal.org/project/content_model_documentation)
- [Drupal Knowledge Archive Network (DKAN Open Data Portal)](https://github.com/GetDKAN/dkan)
- [CMSDS Open Data Components](https://github.com/GetDKAN/cmsds-open-data-components)
- [CMSDS Open Data Components](https://github.com/GetDKAN/cmsds-open-data-components)
- [Drydock Cloud](https://github.com/drydockcloud)
- [Entity Field Fetch field](https://www.drupal.org/project/entity_field_fetch)
- [GovDelivery Bulletins](https://www.drupal.org/project/govdelivery_bulletins)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ When a new module is needed we try to follow [Contrib First](../../../common-pra
- Choose a meaningful search engine friendly module name. (crowd sourcing name suggestions is recommended)

Check warning on line 14 in practice-areas/engineering/drupal/drupal-contrib-first-module-development.md

View workflow job for this annotation

GitHub Actions / remark-lint-problem

[remark-lint-problem] practice-areas/engineering/drupal/drupal-contrib-first-module-development.md#L14

Unexpected unaligned list item child, expected to align with first child, remove `1` space list-item-content-indent remark-lint
Raw output
14:5     warning Unexpected unaligned list item child, expected to align with first child, remove `1` space list-item-content-indent remark-lint
- Create the Drupal project on Drupal.org
- Populate the project page with a description of what is coming. List supporters as CivicActions and the client [directions](./README.md#contribution-to-drupalorg-modules-and-themes). If the client does not have a drupal.org page, get help from your PM to encourage them to create one.

5. Populate the issue queue on the Drupal project with "Feature requests". Keep them as atomic as possible. Mark any that are part of the MVP as "major". Create issues for any improvement ideas that pop up. They don't all have to be acted on, but they help shape the road map for where you want the module to go.

Check warning on line 18 in practice-areas/engineering/drupal/drupal-contrib-first-module-development.md

View workflow job for this annotation

GitHub Actions / remark-lint-suggestions

[remark-lint-suggestions] practice-areas/engineering/drupal/drupal-contrib-first-module-development.md#L18

Unexpected potentially insensitive use of `pop`, in somes cases `parent` may be better dad-mom retext-equality
Raw output
18:200-18:203 warning Unexpected potentially insensitive use of `pop`, in somes cases `parent` may be better                 dad-mom               retext-equality
6. Close the issues as you go and be sure to credit yourself, CivicActions, and the client.
7. Begin with alpha releases. Ideally when all your MVP/major issues are closed, you are ready for the official release.
Expand Down

0 comments on commit 2f3e59c

Please sign in to comment.