Skip to content

Commit

Permalink
1450-Add Contrig First documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Steve Wirt authored and Steve Wirt committed Oct 17, 2024
1 parent 5a4569b commit 83ad6a0
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
2 changes: 2 additions & 0 deletions common-practices-tools/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ title: Common practices and tools

As part of our [CivicActions culture](../about-civicactions/culture.md), we share a set of practices and tools to be effective communicators, team members [working in Agile](agile/README.md), and managers of client work and company administration.

As good stewards of OpenSource we practice a Contribute First approach.

Check warning on line 9 in common-practices-tools/README.md

View workflow job for this annotation

GitHub Actions / remark-lint-suggestions

[remark-lint-suggestions] common-practices-tools/README.md#L9 

Unexpected potentially insensitive use of `stewards`, in somes cases `flight attendants` may be better stewardesses-stewards retext-equality
Raw output 
9:9-9:17  warning Unexpected potentially insensitive use of `stewards`, in somes cases `flight attendants` may be better stewardesses-stewards retext-equality

Underpinning our chosen technology stack is a [required security awareness process](security/README.md) that gets everyone set up to work online safely and avoid the scourge of [phishing](security/README.md#phishing-and-social-engineering).

## Get support
Expand Down
23 changes: 23 additions & 0 deletions common-practices-tools/contribution/contrib-first.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Contrib First
Whenever we are building something that could be of use to more than just one project or client, we build it as contributed work first.

Check warning on line 2 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#L2 

Unexpected potentially insensitive use of `just`, try not to use it                                    just                  retext-equality
Raw output 
2:70-2:74 warning Unexpected potentially insensitive use of `just`, try not to use it                                    just                  retext-equality

## 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. 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)
- **Reusablity** - CivcActions other clients can benefit from work that was already done.
- **Security** - contributing our work to an open source project like Drupal means it it receives security coverage by the Drupal security team and the public.

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

View workflow job for this annotation

GitHub Actions / remark-lint-problem

[remark-lint-problem] common-practices-tools/contribution/contrib-first.md#L8 

Unexpected repeated `it`, remove one occurrence        it    retext-repeated-words
Raw output 
8:84-8:89   warning Unexpected repeated `it`, remove one occurrence        it    retext-repeated-words
- **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.

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

View workflow job for this annotation

GitHub Actions / remark-lint-problem

[remark-lint-problem] common-practices-tools/contribution/contrib-first.md#L9 

Unexpected 2 spaces between sentence, expected 1 space space retext-sentence-spacing
Raw output 
9:274-9:276 warning Unexpected 2 spaces between sentence, expected 1 space space retext-sentence-spacing
- **Development happens in the open** - The issue are public. The commits are public. Everyone can contribute.

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

View workflow job for this annotation

GitHub Actions / remark-lint-problem

[remark-lint-problem] common-practices-tools/contribution/contrib-first.md#L10 

Unexpected 2 spaces between sentence, expected 1 space space retext-sentence-spacing
Raw output 
10:86-10:88 warning Unexpected 2 spaces between sentence, expected 1 space space retext-sentence-spacing

## Examples of modules CivicActions built as contrib first

- [Allow Only One](https://www.drupal.org/project/allow_only_one)
- [Codit: Batch Operations](https://www.drupal.org/project/codit_batch_operations)
- [Codit: Menu Tools](https://www.drupal.org/project/codit_menu_tools)
- [Content Model & Site Documentation](https://www.drupal.org/project/content_model_documentation)
- [Entity Field Fetch field](https://www.drupal.org/project/entity_field_fetch)
- [GovDelivery Bulletins](https://www.drupal.org/project/govdelivery_bulletins)
- [Mermaid Diagram Field](https://www.drupal.org/project/mermaid_diagram_field)
- [Node Link Report](https://www.drupal.org/project/node_link_report)
- [Post API](https://www.drupal.org/project/post_api)
- [Vertex AI Search](https://www.drupal.org/project/vertex_ai_search)

0 comments on commit 83ad6a0

Please sign in to comment.