From d6d1e77c744ebe76628720290505d15fadeeeefa Mon Sep 17 00:00:00 2001 From: ressa <ressa@102134.no-reply.drupal.org> Date: Wed, 10 Aug 2022 13:05:47 +0000 Subject: [PATCH] Issue #3296324 by ressa, chrisfromredfin, omkar-pd: Update Contributing section in README --- README.md | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index f4d642eb5..fc25ef1dc 100644 --- a/README.md +++ b/README.md @@ -9,26 +9,31 @@ Our goal is to make it easier to find and install modules for people new to Drup - For the description of the module visit: [https://www.drupal.org/project/project_browser](https://www.drupal.org/project/project_browser) - To submit bug reports and feature suggestions or to track changes, visit: [https://www.drupal.org/project/issues/project_browser?categories=All](https://www.drupal.org/project/issues/project_browser?categories=All) + ## Requirements ------------- This module requires no modules outside of Drupal core. ## Installation ------------- -*If you intend to contribute to Project Browser, skip this step and use the "Contributing" instructions instead* +*If you intend to contribute to Project Browser, skip this step and use the "Contributing" instructions instead* Install with composer: `composer require drupal/project_browser` then enable the module. -# Contributing +## Contributing + - Follow the [Git instructions](https://www.drupal.org/project/project_browser/git-instructions - ) to clone project browser to your site. + ) to clone project browser to your site - In the `/project_browser` directory, install PHP dependencies with `composer install` -- In the `/project_browser/sveltejs` directory install JS dependencies `yarn install` and run the dev script `yarn dev` which will watch for filesystem changes - - Note: `yarn dev` will report the app is availble localhost, but it is fully available in your Drupal site at `admin/modules/browse` +- In the `/project_browser/sveltejs` directory: + - install JS dependencies with `yarn install` + - For development, run the dev script `yarn dev` which will watch for filesystem changes + - Note: `yarn dev` will report the app is available localhost, but it is fully available in your Drupal site at `admin/modules/browse` + - When you are done, compile the changes with `yarn build` + +_NOTE: More information is available in the contributor.md file!_ ## Configuration @@ -38,11 +43,12 @@ Filter by Recommended projects or All projects Search and filter by Title, Sort By, Order and Categories Customize results layout by List or Grid Format + ## Maintainers --Leslie Glynn (leslieg) - https://www.drupal.org/u/leslieg --Chris Wells (chrisfromredfin) - https://www.drupal.org/u/chrisfromredfin --Ron Northcutt (rlnorthcutt) - https://www.drupal.org/u/rlnorthcutt --Tim Plunkett (tim.plunkett) - https://www.drupal.org/u/timplunkett --Matthew Grasmick (grasmash) - https://www.drupal.org/u/grasmash +- Leslie Glynn (leslieg) - https://www.drupal.org/u/leslieg +- Chris Wells (chrisfromredfin) - https://www.drupal.org/u/chrisfromredfin +- Ron Northcutt (rlnorthcutt) - https://www.drupal.org/u/rlnorthcutt +- Tim Plunkett (tim.plunkett) - https://www.drupal.org/u/timplunkett +- Matthew Grasmick (grasmash) - https://www.drupal.org/u/grasmash -- GitLab