Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added section for contributing back to Drupal for project teams #1488

Merged
merged 5 commits into from
Dec 30, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 @@ -17,7 +17,7 @@
- **Scalability** - Contributed FOSS is more scalable than one-off solutions and can grow with the power of the FOSS community.
- **Visibility** - CivicActions, our developers and clients earn positive representation as technology leaders and contributors.
- **Economy of tests** - Unit, Kernel and Functional tests for the module are run on the pipeline on Drupal.org. This translates into savings because they not slowing down custom tests running on client servers (human time savings). They run when the module is updated, not every time custom tests run (server cost savings).
dmundra marked this conversation as resolved.
Show resolved Hide resolved
- **Digital Public Goods** - We know that contributing to the digital commons helps everyone. We know that we need to contribute to [digital publid goods](https://en.wikipedia.org/wiki/Digital_public_goods) and not simply use them.
- **Digital Public Goods** - We know that contributing to the digital commons helps everyone. We know that we need to contribute to [digital public goods](https://en.wikipedia.org/wiki/Digital_public_goods) and not simply use them.

Check warning on line 20 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#L20

Unexpected potentially insensitive use of `simply`, try not to use it simple retext-equality
Raw output
20:218-20:224 warning Unexpected potentially insensitive use of `simply`, try not to use it simple      retext-equality

## Examples of FOSS CivicActions built as Contrib First

Expand Down
33 changes: 33 additions & 0 deletions practice-areas/engineering/drupal/drupal-for-project-teams.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,36 @@
### Views

Views are listings of content on your site. Drupal's views are highly customizable and provide many different ways that you can list content. Drupal comes with two modules for using views on your site. The first module is the Views module which handles displaying the view to the user. The second is the Views UI module which allows users (with the right permissions) to create and edit their views via the administrative interface. An example use-case for a view could be a news site landing page that shows teasers of news articles sorted by date published.

## Contributing back

Consider [Contrib First](../../../common-practices-tools/contribution/contrib-first.md) when working with Drupal and any open source software.

As the project grows and uses Drupal modules keep track of the following lists of technical debt related to Drupal to revisit at regular times in the project. Here is a quote you can add to your project to ask for approval to work on contributing back.
dmundra marked this conversation as resolved.
Show resolved Hide resolved

> Work on drupal.org issues that directly impact project work, like updating modules to support newer versions of Drupal, create supported/secure releases, take over maintenance of a module, review/test patches.

Check warning on line 73 in practice-areas/engineering/drupal/drupal-for-project-teams.md

View workflow job for this annotation

GitHub Actions / remark-lint-suggestions

[remark-lint-suggestions] practice-areas/engineering/drupal/drupal-for-project-teams.md#L73

Unexpected hard to read sentence, according to 5 out of 7 algorithms readability retext-readability
Raw output
73:3-73:212   warning Unexpected hard to read sentence, according to 5 out of 7 algorithms  readability retext-readability

### List of modules that need releases, new maintainers, or needs to be removed

Modules can become out of date in many ways (maintainers stopped working on it, it became a core feature, it is defunct/deprecated, and so on). Review the modules and if they are no longer needed on the project remove them. If they are still needed but are no longer maintained, try to take over maintenance of the module.

See [Drupal.org Maintainership page](https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or-distribution-project/maintainership) for more details.

### List of modules that are committed directly to the repository instead of being included via composer

Review the reason for this and whether any customization could be removed or contributed back (as patches) so that the module could be tracked via composer again.

### List of modules we could contribute back

Review the list of custom modules and figure out whether the changes could be made generic and then shared with the community. See [The most important decision in developing a Drupal site: contributed vs. custom development](most-important-decision-in-developing-a-drupal-site-contributed-vs-custom-development.md) for more details.

### Review composer patches

Review the file composer files for patches we apply, then:

- Check the issue in drupal.org to see if the patch needs to be updated either by us sharing it or we download and apply a new one.
- Share patches we have created by creating new issues as needed.

### Review team member's own list of Drupal.org modules and issues

Everyone who has a Drupal.org account and worked on issues is automatically following those issues. Have them share those links and then work on those issues if they are still open.
Loading