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

Defining / documenting a process for Requests For Help (RFH) #372

Closed
thescientist13 opened this issue Jun 16, 2020 · 1 comment · Fixed by #376
Closed

Defining / documenting a process for Requests For Help (RFH) #372

thescientist13 opened this issue Jun 16, 2020 · 1 comment · Fixed by #376
Assignees
Labels
package-maintenance-agenda Agenda items for package-maintenance team

Comments

@thescientist13
Copy link
Contributor

thescientist13 commented Jun 16, 2020

Overview

In seeing a couple teams reaching out directly to this group for assistance and guidance

As well as similar request happening on twitter

It might good to define and document a standard operating procedure, or some sort of expectation of what this group can provide. For example, looking at the main README.md as one might expect for a package, there is no equivalent "Getting Started" or "Usage" section that might indicate to a reader there are docs, tools, developers, inside and related to this repo.

This way, in situations like this someone could link to this section as a one stop shop, so to speak.

Proposal

Add a section to the README, that would be ongoing and growing as this team continues to make more documentation, tools, etc available as resources for package authors. This section could be called "Resources"? I am not too picky about the name, tbh.

It should / could contain

  1. Any specific policies, expectations of the team, etc
  2. Link to docs table of contents (recently added in Issue/309 docs table of contents #333 )
  3. Other things that are ready?
@thescientist13 thescientist13 added the package-maintenance-agenda Agenda items for package-maintenance team label Jun 16, 2020
@thescientist13 thescientist13 changed the title Request For Help - defining a process / sop Defining a process for Request For Help (RFH) Jun 16, 2020
@thescientist13 thescientist13 changed the title Defining a process for Request For Help (RFH) Defining / documenting a process for Requests For Help (RFH) Jun 16, 2020
@thescientist13 thescientist13 self-assigned this Jun 29, 2020
@thescientist13
Copy link
Contributor Author

thescientist13 commented Jun 29, 2020

Just observed there is a project for tracking this kind of help, so will add some of the referenced projects there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package-maintenance-agenda Agenda items for package-maintenance team
Projects
None yet
1 participant