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

added bare-bones CONTRIBUTORS.md file #973

Merged
merged 5 commits into from
Mar 22, 2022

Conversation

todd-mystenlabs
Copy link
Contributor

This is primarily a placeholder that we'll fill out in the future re: any requirements we have for contributing, as well as a list of contributors.

CONTRIBUTORS.md Outdated

## How to Contribute

Stay tuned. Mysten Labs is not yet ready to accept pull request contributions from the public. We will provide more details in the future, laying out requirements for contributing to the project.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😮 Why on earth not?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a desire to get the following groundwork in place first:

  • contributor requirements (adhering to code of conduct, any legal elements needed to be put in place, etc.)
  • guidance on what we'll accept (alignment with roadmap)
  • any other community process details worked out

So the desire is to get public involvement, but we're not ready yet to specify how that'll work, @huitseeker.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

@huitseeker huitseeker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the issue is that we don't know what to put in a CONTRIBUTING.md document, we can crib from the standard Node.js one:
https://github.com/nodejs/node/blob/master/CONTRIBUTING.md#pull-requests
Or the Facebook one:
https://github.com/MystenLabs/narwhal/blob/main/CONTRIBUTING.md

Which are both pretty standard.

If we actually intend to release an open-source project and discourage contributions, I think we should reconsider open-sourcing at all, as long as we work in this ecosystem.

@todd-mystenlabs
Copy link
Contributor Author

@huitseeker Sorry ignore the re-review request.

I can add some other verbiage along the lines of what you specified. I just want to make sure we have everything lined up before we start actively looking like we're expecting PRs. Right now, we're not. Maybe the better way to do that is to not have this file here just yet.

@huitseeker
Copy link
Contributor

before we start actively looking like we're expecting PRs. Right now, we're not

I'm confused. What is the liability in "actively looking like we're expecting PRs."?

@gdanezis gdanezis added the Type: Documentation Improvements or additions to documentation label Mar 21, 2022
Add link to existing Contributing to Sui page
@Clay-Mysten
Copy link
Contributor

Todd, we should also link to your Issues file.

@todd-mystenlabs
Copy link
Contributor Author

Pulled out the part about not being ready for PRs.

The file is now just a link to the dev portal version.

@todd-mystenlabs
Copy link
Contributor Author

@Clay-Mysten - will add a link to the ISSUES.md file. I think you're right in that it will need to go here, since the ISSUES.md file lives at the root level and I don't think the dev portal contributions content can link to it.

@Clay-Mysten
Copy link
Contributor

@Clay-Mysten - will add a link to the ISSUES.md file. I think you're right in that it will need to go here, since the ISSUES.md file lives at the root level and I don't think the dev portal contributions content can link to it.

Exactly. We can link to it from our Contributing to Sui page though. Will do that now.

Copy link
Contributor

@huitseeker huitseeker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@todd-mystenlabs
Copy link
Contributor Author

@Clay-Mysten - do you have any backlinks to this file? Or can I just rename it?

@todd-mystenlabs
Copy link
Contributor Author

Oops I see we've already got it renamed.

@todd-mystenlabs
Copy link
Contributor Author

@Clay-Mysten - this PR is stuck until somebody other than me approves the changes Francois proposed. (I can't approve it as the PR owner).

@Clay-Mysten
Copy link
Contributor

@Clay-Mysten - this PR is stuck until somebody other than me approves the changes Francois proposed. (I can't approve it as the PR owner).

I believe @huitseeker needs to approve since he is the one who requested changes. I have already approved.

Copy link
Contributor

@huitseeker huitseeker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@todd-mystenlabs todd-mystenlabs merged commit 40b870d into MystenLabs:main Mar 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants