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

Update README.md and added CODEOWNERS #101

Merged
merged 5 commits into from
Mar 29, 2023

Conversation

BigLep
Copy link
Contributor

@BigLep BigLep commented Mar 28, 2023

Making clear the repo status per ipfs/boxo#218

Note that no "deprecated types" are being added. There is only a general notice that this repo is on a deprecation path and a pointer to the code copy that Kubo uses. Any code that @ipfs/kubo-maintainers own will switch to the Boxo version. A CODEOWNERS was added to clarify who will look at any PRs or do mandatory fixes here (likely in sync with @ipfs/kubo-maintainers since both sides are generally only doing critical changes here.)

Making clear the repo status per ipfs/boxo#218
@welcome
Copy link

welcome bot commented Mar 28, 2023

Thank you for submitting this PR!
A maintainer will be here shortly to review it.
We are super grateful, but we are also overloaded! Help us by making sure that:

  • The context for this PR is clear, with relevant discussion, decisions
    and stakeholders linked/mentioned.

  • Your contribution itself is clear (code comments, self-review for the
    rest) and in its best form. Follow the code contribution
    guidelines

    if they apply.

Getting other community members to do a review would be great help too on complex PRs (you can ask in the chats/forums). If you are unsure about something, just leave us a comment.
Next steps:

  • A maintainer will triage and assign priority to this PR, commenting on
    any missing things and potentially assigning a reviewer for high
    priority items.

  • The PR gets reviews, discussed and approvals as needed.

  • The PR is merged by maintainers when it has been approved and comments addressed.

We currently aim to provide initial feedback/triaging within two business days. Please keep an eye on any labelling actions, as these will indicate priorities and status of your contribution.
We are very grateful for your contribution!

@BigLep
Copy link
Contributor Author

BigLep commented Mar 28, 2023

2023-03-28 conversation with @rvagg : he is going to:

  1. Better explain the landscape
  2. Adjust the CODEOWNERS list

@rvagg
Copy link
Member

rvagg commented Mar 29, 2023

Updated this PR, making myself the only "CODEOWNER" (let me know if you really want to be in that party, but I'm assuming that nobody else really wants to) and changed the framing in the README to:

This library is maintained, but not actively developed. It will continue to receive fixes and security updates for users that depend on it. However, it may be deprecated in the future and it is recommended that you use alternatives to the functionality in go-merkledag, including:

...with a list of links including the kubo fork

Will merge if I don't get feedback in a couple of days.

@BigLep
Copy link
Contributor Author

BigLep commented Mar 29, 2023

Great updates @rvagg! Let's merge. Followups can always be made if needed.

@BigLep
Copy link
Contributor Author

BigLep commented Mar 29, 2023

I'm going to merge since @rvagg and I have reviewed and I want to close out ipfs/boxo#218. If there are additions/changes they can get made after.

@BigLep BigLep merged commit 0bbf3ec into master Mar 29, 2023
@rvagg rvagg deleted the chore/update-readme-and-add-codeowners branch March 30, 2023 08:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants