Skip to content

Commit

Permalink
Linting language changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
Steve Wirt authored and Steve Wirt committed Oct 22, 2024
1 parent 960396e commit 0fb1326
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion common-practices-tools/contribution/contrib-first.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Whenever we are building something that could be of use by more than one project
- **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 12 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#L12

Unexpected potentially insensitive use of `just`, try not to use it just retext-equality
Raw output
12:137-12:141 warning Unexpected potentially insensitive use of `just`, try not to use it                                    just                  retext-equality

Check warning on line 12 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#L12

Unexpected 2 spaces between sentence, expected 1 space space retext-sentence-spacing
Raw output
12:155-12:157 warning Unexpected 2 spaces between sentence, expected 1 space                                       space                      retext-sentence-spacing

Check warning on line 12 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#L12

Unexpected 2 spaces between sentence, expected 1 space space retext-sentence-spacing
Raw output
12:245-12:247 warning Unexpected 2 spaces between sentence, expected 1 space                                       space                      retext-sentence-spacing
- **Scalability** - Contributed FOSS is more scalable than one-off solutions and can grow with the power of the FOSS community.
- **Visibility** - When we release FOSS, our developers, CivicActions and our clients get positive representation as being technology leaders and contributors.
- **Visibility** - When we release FOSS, CivicAction, our developers and our clients get positive representation as technology leaders and contributors.

Check warning on line 14 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#L14

Unexpected hard to read sentence, according to 5 out of 7 algorithms readability retext-readability
Raw output
14:7-14:155   warning Unexpected hard to read sentence, according to 5 out of 7 algorithms                                   readability           retext-readability

## Examples of modules CivicActions built as Contrib First

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ When a new module is needed we try to follow [Contrib First](../../../common-pra
2. Gather requirements and identify MVP vs nice-to-haves
3. Search for existing modules that might solve the problem. (It might be easier to stretch an existing module than build a new one)
4. If opting to build a new module:
- Choose a meaningful search engine friendly module name. (crowd sourcing name suggestions is recommended)
- 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.
- Choose a meaningful search engine friendly module name. (crowd sourcing name suggestions is recommended)

Check warning on line 10 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#L10

Unexpected unaligned list item child, expected to align with first child, remove `1` space list-item-content-indent remark-lint
Raw output
10: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 13 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#L13

Unexpected potentially insensitive use of `pop`, in somes cases `parent` may be better dad-mom retext-equality
Raw output
13:201-13:204 warning Unexpected potentially insensitive use of `pop`, in somes cases `parent` may be better                 dad-mom               retext-equality

Check warning on line 13 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#L13

Unexpected 2 spaces between sentence, expected 1 space space retext-sentence-spacing
Raw output
13:75-13:77   warning Unexpected 2 spaces between sentence, expected 1 space                                       space                      retext-sentence-spacing
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
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ In summary:
- When it's necessary to build anew, focus first on doing so to a high, generic, contributed standard.
- Try to produce custom (site-specific closed source) modules only when the needs are limited in scope and truly specific to the site.
- Try to save the theme layer for what it's intended for--final presentation, look and feel.
- When we work on a FOSS contribution for a client(s), all of the work should be billable to that client. In the event we are doing maintenance on a contribution for no particular client, then that work can be declared as community participation (PRODEV_COMPART ->Community Participation). You will need to ask in Slack #unanet to be added to your options.
- When we work on a FOSS contribution for a client(s), all of the work should be billable to that client. When doing maintenance on a contribution for no particular client, that work should be reccorded as community participation (PRODEV_COMPART ->Community Participation). You will need to ask to be added to your options in Slack #unanet.

Check warning on line 37 in practice-areas/engineering/drupal/drupal-developer-tips-for-getting-the-most-out-of-open-source.md

View workflow job for this annotation

GitHub Actions / remark-lint-suggestions

[remark-lint-suggestions] practice-areas/engineering/drupal/drupal-developer-tips-for-getting-the-most-out-of-open-source.md#L37

Unexpected hard to read sentence, according to 5 out of 7 algorithms readability retext-readability
Raw output
37:110-37:277 warning Unexpected hard to read sentence, according to 5 out of 7 algorithms                                   readability           retext-readability

Check warning on line 37 in practice-areas/engineering/drupal/drupal-developer-tips-for-getting-the-most-out-of-open-source.md

View workflow job for this annotation

GitHub Actions / remark-lint-problem

[remark-lint-problem] practice-areas/engineering/drupal/drupal-developer-tips-for-getting-the-most-out-of-open-source.md#L37

Unexpected 2 spaces between sentence, expected 1 space space retext-sentence-spacing
Raw output
37:108-37:110 warning Unexpected 2 spaces between sentence, expected 1 space                                       space                      retext-sentence-spacing

## Patching vs. hacking vs. forking

Expand Down

0 comments on commit 0fb1326

Please sign in to comment.