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

README suggestions #12

Open
BigLep opened this issue Sep 8, 2023 · 1 comment
Open

README suggestions #12

BigLep opened this issue Sep 8, 2023 · 1 comment
Labels
need/triage Needs initial labeling and prioritization

Comments

@BigLep
Copy link

BigLep commented Sep 8, 2023

Some things coming to mind when landing at https://github.com/ipfs/helia-remote-pinning:

  1. Rather than have a "Lead Maintainer" section, just codify this in CODEOWNERS? I assume codeowners should be helia-dev.
  2. Provide some explanation for why use this package (i.e., it's a convenience wrapper for binding Helia and pinning service providing promise for when certain actions have been completed)
  3. The design document is linked in the right hand side project description. Ideally we'd like to design docs from the README.
  4. I know covered elsewhere, but link to any relevant examples.
  5. Make sure the project is linked from https://github.com/ipfs/helia for discoverability
@BigLep BigLep added the need/triage Needs initial labeling and prioritization label Sep 8, 2023
@welcome
Copy link

welcome bot commented Sep 8, 2023

Thank you for submitting your first issue to this repository! A maintainer will be here shortly to triage and review.
In the meantime, please double-check that you have provided all the necessary information to make this process easy! Any information that can help save additional round trips is useful! We currently aim to give initial feedback within two business days. If this does not happen, feel free to leave a comment.
Please keep an eye on how this issue will be labeled, as labels give an overview of priorities, assignments and additional actions requested by the maintainers:

  • "Priority" labels will show how urgent this is for the team.
  • "Status" labels will show if this is ready to be worked on, blocked, or in progress.
  • "Need" labels will indicate if additional input or analysis is required.

Finally, remember to use https://discuss.ipfs.io if you just need general support.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
need/triage Needs initial labeling and prioritization
Projects
None yet
Development

No branches or pull requests

1 participant