Skip to content

Do git/github helpful hints belong in per-repo READMEs or should we centralize them? #22

@eagunn

Description

@eagunn

@naomi-yoder I appreciate you doing the work to compile the git/github helpful hints that are now in our README file. But I have some concerns:

  • I don't think every project should maintain its own version of this content. It's a lot of work to compile and would be a lot of work to update if something about our (or the tool's) recommended process changes.
  • If we do keep this content, we should do another update to adopt @switzersc's recommendation to format git commands as code,
    e.g. git add .
  • I have a specific concern about your note:
You can fork (copy) this Public-Environmental-Data-Partners/scripts repo to your own account. To do that, you must already be authorized to work in the PEDP GitHub.

I don't think that is quite right. One might have to be authorized to clone and commit directly to a new branch. But our repo is public and anyone should be able to fork and submit PRs from their fork.

@switzersc Would you consider adding a version of @naomi-yoder's notes as a separate .md in the overview repo and linking to it from the Contributing page?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions