Problem/Motivation

The README is the first entry point to learning about how to work with and contribute to project browser, but the first few things it mentions are not necessarily the right/best way to get started.

Proposed resolution

  1. Update the README to remove the first section about Acquia CLI, and potentially replace with some GitPod instructions.
  2. Replace the second section with proper instructions for the right repo/branch etc.
  3. Issues to address section can be modified or removed.

Remaining tasks

  • ✅ File an issue about this project
  • ☐ Addition/Change/Update/Fix to this project
  • ☐ Code review from 1 PB team member
  • ☐ Full testing and approval
  • ☐ Credit contributors
  • ☐ Release

Issue fork project_browser-3268626

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

chrisfromredfin created an issue. See original summary.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Assigned: Unassigned » volkswagenchick

I am assigned this to myself and will be working with the Discover Drupal Students this week and next to update the README.me file.
Thanks

PLEASE - We ask that this issue be reserved for the Discover Drupal graduates and mentors so we can work together as a group and become more comfortable with the process.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented

@chrisfromredfin - I read the issue summary.

Did you want the readme to include contrib instructions and/or do you want a contributor.md file?

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented

We decided as a group to open an issue to create a contributor.md file.

A README.md file should follow this template:
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

chrisfromredfin’s picture

chrisfromredfin
he/him/his
Primary language English
Location Portland, Maine
commented

Sorry I was late to this party but the good news is you made totally the right call. :) README.md to follow the template and CONTRIBUTOR.md - *chef's kiss*

Thanks!

jjcs227’s picture

jjcs227
Primary language Spanish
Location Houston, TX
commented

We've been working on this file:https://docs.google.com/document/d/1xghcDxuRf2-DPGfd2V-D-osEB-zhtVp2Shff...
We will really appreciate your comments and suggestions to have it ready.

chrisfromredfin’s picture

chrisfromredfin
he/him/his
Primary language English
Location Portland, Maine
commented

Thanks jj - I've put some comments there, as have some other folks. Thanks for your work!

jjcs227’s picture

jjcs227
Primary language Spanish
Location Houston, TX
commented

Thank you @chrisfromredfin. I'll work on those comments, and I'll have the installation part reviewed as well.

bnjmnm made their first commit to this issue’s fork.

tim.plunkett’s picture

tim.plunkett
he/him
Primary language English
Location Philadelphia
commented
Issue tags: +Project Browser MVP

bnjmnm opened merge request !79

bnjmnm’s picture

bnjmnm
he/him
Primary language English
Location Ann Arbor, MI
commented
Status: Active » Needs review

I think it would be good to not review this one too strictly. If something is flat out incorrect obviously it should be changed, but it would be good to get the very-outdated parts of the README addressed ASAP, then refining it can happen in followup issues.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Assigned: volkswagenchick » Unassigned

Unassigning myself. I forgot to earlier.

I second @bnjmnm comments on not being 100% strict and just moving this forward.

tim.plunkett’s picture

tim.plunkett
he/him
Primary language English
Location Philadelphia
commented
Assigned: Unassigned » chrisfromredfin
Status: Needs review » Reviewed & tested by the community

Looks good to me, leaving for @chrisfromredfin to merge if he's good with it.

Side-note, kinda wild that

Ron Northcutt (rlnorthcutt)
Tim Plunkett (tim.plunkett)
Matthew Grasmick (grasmash)

all have the same line lengths 🤓

tim.plunkett’s picture

tim.plunkett
he/him
Primary language English
Location Philadelphia
commented
Status: Reviewed & tested by the community » Fixed

Merged, thanks!

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented

Could we give credit to the folks who helped write the initial version of the readme? Thanks

  • AmyJune - volkswagenchick
  • Jose J. Colmenares - jjcs227
  • nadia - NadiaFaucon
  • Devon - Devon_4224
  • Joseph - prodigyjoe

tim.plunkett credited Devon_4224.

tim.plunkett credited NadiaFaucon.

tim.plunkett credited prodigyjoe.

tim.plunkett’s picture

tim.plunkett
he/him
Primary language English
Location Philadelphia
commented

Adding credit

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.