fix: Adds missing parenthesis in readme

OpenMined / SyferText

A privacy preserving NLP framework

Apache License 2.0

198 stars 49 forks source link

fix: Adds missing parenthesis in readme #166

Closed darigovresearch closed 4 years ago

darigovresearch commented 4 years ago

Description

Corrects the missing closing parenthesis in the introductory paragraph of the readme

Affected Dependencies

None

How has this been tested?

Correction is rendered correctly in GitHub readme

Checklist

[x] I have followed the Contribution Guidelines and Code of Conduct
[x] I have commented my code following the OpenMined Styleguide
[x] I have labeled this PR with the relevant Type labels
[x] My changes are covered by tests

darigovresearch commented 4 years ago

Would resolve Issue #167 if merged

darigovresearch commented 4 years ago

Am not sure if the tests are relevant here as the only modification to the code was in the readme. Could anyone please advise?

hershd23 commented 4 years ago

Hey syfertext is formatted using black and the tests here are to check whether there is any issue in the formatting. From the main directory just do a black syfertext/ command and then commit.

Edit :- Checked the changes made, since it's only in one file and I think the master build is failing as is so this should be good to go. @Nilanshrajput take a look here

Nilanshrajput commented 4 years ago

Hmm, seems like the last commit on the master was with a different version of black, @darigovresearch can you install latest black with pip, and do as @hershd23 said black syfertext and black setup.py

darigovresearch commented 4 years ago

@hershd23 & @Nilanshrajput thanks for taking a look and the advice, I have just now committed & pushed the after doing the requested commands

Nilanshrajput commented 4 years ago

hey one more step just do black tests also. (you can do black SyferText from parent directory to ensure everything inside repo is formated)

darigovresearch commented 4 years ago

Done now, everything should be in order!

Do you think it would be worth adding a contributing.md file like similar to PySyft to outline how to do a pull request including needing black and to run the one specific command?

Happy to adapt that repository's readme & contributing.md file to make this work in another pull request!

Nilanshrajput commented 4 years ago

Good work @darigovresearch, congrats for your first contribution in SferText!!!

darigovresearch commented 4 years ago

@Nilanshrajput & @hershd23 thanks for guiding me through it! Shall I open an issue and do a pull request to help make the contributing process a little clearer and hopefully get more people contributing to the project?

Done now, everything should be in order!

Do you think it would be worth adding a contributing.md file like similar to PySyft to outline how to do a pull request including needing black and to run the one specific command?

Happy to adapt that repository's readme & contributing.md file to make this work in another pull request!

Nilanshrajput commented 4 years ago

Nice idea @darigovresearch , go for it create a pr. Thank you!

darigovresearch commented 4 years ago

Sounds good & will do!