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

docs: contributing #174

Merged
merged 14 commits into from
May 22, 2021
Merged

docs: contributing #174

merged 14 commits into from
May 22, 2021

Conversation

danielorihuela
Copy link
Contributor

@danielorihuela danielorihuela commented May 15, 2021

Description

Copied and modified the contributing documentation from PySyft.
Explains how to install and test SyMPC.

Closes #58

Checklist

Copied and modified from PySyft contributing.
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Contributor

@aanurraj aanurraj left a comment

Choose a reason for hiding this comment

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

Looks good, I requested few changes you might need to do that. Also, have you checked all the steps if they are working correctly?

@aanurraj aanurraj added the documentation Improvements or additions to documentation label May 15, 2021
@aanurraj aanurraj requested a review from gmuraru May 15, 2021 19:23
@danielorihuela
Copy link
Contributor Author

danielorihuela commented May 15, 2021

Looks good, I requested few changes you might need to do that. Also, have you checked all the steps if they are working correctly?

I checked all except the windows and macos parts, I only have a linux computer.
Also, there is a problem with the requirements.txt and requirements.dev.txt when you try to install them. But I guess that is due to the transformation of pysyft main repo to a monorepo.

@gmuraru
Copy link
Member

gmuraru commented May 15, 2021

Looks good, I requested few changes you might need to do that. Also, have you checked all the steps if they are working correctly?

I checked all except the windows and macos parts, I only have a linux computer.
Also, there is a problem with the requirements.txt and requirements.dev.txt when you try to install them. But I guess that is due to the transformation of pysyft main repo to a monorepo.

It should work now.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Member

@gmuraru gmuraru left a comment

Choose a reason for hiding this comment

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

I will give tomorrow another look - but added some comments

Copy link
Member

@gmuraru gmuraru left a comment

Choose a reason for hiding this comment

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

LGTM!

@gmuraru
Copy link
Member

gmuraru commented May 21, 2021

Only solve the conflict and I think this is good to go 🚀

@danielorihuela
Copy link
Contributor Author

All tests passed but is waiting for python-tests (3.8). Is that a bug?

@gmuraru
Copy link
Member

gmuraru commented May 21, 2021

All tests passed but is waiting for python-tests (3.8). Is that a bug?

I updated the branch. I am not sure...I have seen it hold up one other time - let's see them now

@gmuraru
Copy link
Member

gmuraru commented May 21, 2021

I will force squash and merge this after the tests are passing

@danielorihuela
Copy link
Contributor Author

danielorihuela commented May 21, 2021

I will force squash and merge this after the tests are passing

As you wish, but I would not like that this behaviour gets expanded to all PRs. Are you sure this will disappear?

It is curious, I have done a run in my fork and that bug does not happen.
danielorihuela#13 (comment)

@gmuraru gmuraru requested a review from aanurraj May 21, 2021 21:19
@gmuraru
Copy link
Member

gmuraru commented May 21, 2021

Asked @aanurraj to look again over this - I think it is good to go, but it is better to have another pair of eyes to look over this 👀

@gmuraru
Copy link
Member

gmuraru commented May 21, 2021

I will force squash and merge this after the tests are passing

As you wish, but I would not like that this behaviour gets expanded to all PRs. Are you sure this will disappear?

It is curious, I have done a run in my fork and that bug does not happen.
danielorihuela#13 (comment)

Yeah...we should keep an eye on this problem...and if this happens once more, we should investigate this.

@gmuraru gmuraru merged commit 80250b1 into OpenMined:main May 22, 2021
@danielorihuela danielorihuela deleted the docs/contributing branch June 24, 2021 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create Contributing.md
7 participants