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.

Sign up for GitHub

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

Jump to bottom

doc: modernize README.md and add CoC #166

Closed
wants to merge 3 commits into from
Closed

doc: modernize README.md and add CoC #166

wants to merge 3 commits into from

Conversation

aqrln
Copy link
Member

@aqrln aqrln commented May 12, 2017

  • Remove obsolete and misleading information from README.md.
  • Make README.md look cleaner.
  • Add a Code of Conduct.
  • Add a simple introductory example to the front page and duplicate it
    in examples/readme-example.
  • Add the list of maintainers.

image

nechaido
nechaido approved these changes May 12, 2017
View reviewed changes
Copy link
Member

@nechaido nechaido left a comment

Choose a reason for hiding this comment

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

LGTM

@belochub
Copy link
Member

@aqrln, please add Refs: https://github.com/metarhia/JSTP/issues/163 to commit description.

@belochub
Copy link
Member

@aqrln, this PR also addresses #157, this #157 (comment) in particular, but it is up to you whether to mention this in commit description or not.

@aqrln
doc: modernize README.md and add CoC
06a066c 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

Refs: #131
Refs: #163
@belochub
Copy link
Member

@aqrln, additions of examples is connected to #131, you should also mention this in commit description.

@aqrln
Copy link
Member Author

aqrln commented May 12, 2017

@belochub I've updated the commit message with appropriate references, thanks!

belochub
belochub approved these changes May 12, 2017
View reviewed changes
Copy link
Member

@belochub belochub left a comment

Choose a reason for hiding this comment

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

LGTM

lundibundi
lundibundi approved these changes May 12, 2017
View reviewed changes
Copy link
Member

@lundibundi lundibundi left a comment

Choose a reason for hiding this comment

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

LGTM

README.md Outdated

We also have official client-side implementations for
[Swift](https://github.com/JSTPMobile/iOS) and
[Java](https://github.com/JSTPMobile/Java) that work effortlessly on iOS and
Copy link
Member

@lundibundi lundibundi May 12, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

Maybe it's better to put 'that work...' on the same line as 'Android', it may be easier to edit later + better diff in case we need to.

Copy link
Member Author

Choose a reason for hiding this comment

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

No strong opinion about that, but done :)

@aqrln
Copy link
Member Author

aqrln commented May 12, 2017 •
edited
Loading

@metarhia/jstp-core given the facts that this PR has already been reviewed by all the possible maintainers (so there's no one to object or request changes anymore) and this is a change we'd like to happen ASAP ('cause the current README is kinda misleading), is it okay for me to go ahead and land this without the minimal waiting time?

@lundibundi
Copy link
Member

@aqrln I think we discussed that it can be landed right away it all maintainers positively reviewed the pr, ain't we?

@aqrln
Copy link
Member Author

aqrln commented May 13, 2017

@lundibundi I don't recall us to have discussed that specific case, but it seems rather logical to me, so I'm gonna merge it right away. Please lmk if this is something that shouldn't have happened.

aqrln added a commit that referenced this pull request May 13, 2017
@aqrln
doc: modernize README.md and add CoC
f6a3e92 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

PR-URL: #166
Refs: #131
Refs: #163
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
@aqrln
Copy link
Member Author

aqrln commented May 13, 2017

Landed in f6a3e92 🚀

@aqrln aqrln closed this May 13, 2017
@aqrln aqrln deleted the update-readme branch May 13, 2017 01:10
nechaido pushed a commit that referenced this pull request May 18, 2017
@aqrln @nechaido
doc: modernize README.md and add CoC
1f5275e 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

PR-URL: #166
Refs: #131
Refs: #163
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
belochub pushed a commit that referenced this pull request Jan 22, 2018
@aqrln @belochub
doc: modernize README.md and add CoC
68c1b22 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

PR-URL: #166
Refs: #131
Refs: #163
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
belochub pushed a commit that referenced this pull request Jan 22, 2018
@aqrln @belochub
doc: modernize README.md and add CoC
b90041e 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

PR-URL: #166
Refs: #131
Refs: #163
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
@belochub belochub mentioned this pull request Jan 22, 2018
Merged
belochub pushed a commit to metarhia/mdsf that referenced this pull request Jul 19, 2018
@aqrln
doc: modernize README.md and add CoC
1cc80c7 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

PR-URL: metarhia/jstp#166
Refs: metarhia/jstp#131
Refs: metarhia/jstp#163
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
belochub pushed a commit to metarhia/mdsf that referenced this pull request Jul 19, 2018
@aqrln
doc: modernize README.md and add CoC
3da9f2a 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

PR-URL: metarhia/jstp#166
Refs: metarhia/jstp#131
Refs: metarhia/jstp#163
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
belochub pushed a commit to metarhia/mdsf that referenced this pull request Jul 21, 2018
@aqrln @belochub
doc: modernize README.md and add CoC
d4f85db 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

PR-URL: metarhia/jstp#166
Refs: metarhia/jstp#131
Refs: metarhia/jstp#163
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@belochub belochub belochub approved these changes

@tshemsedinov tshemsedinov tshemsedinov approved these changes

@lundibundi lundibundi lundibundi approved these changes

@nechaido nechaido nechaido approved these changes

Assignees
No one assigned
Labels
doc meta
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@aqrln @belochub @lundibundi @tshemsedinov @nechaido