ably-flutter icon indicating copy to clipboard operation
ably-flutter copied to clipboard
verified publisher icon ably

Conform ReadMe and Contributing Documents

Open QuintinWillison opened this issue 4 years ago • 3 comments

See comments here and here.

QuintinWillison avatar May 04 '21 10:05 QuintinWillison

@tbedford @QuintinWillison Do we have any standardised README structure yet? If no - it looks like it may be a good chance to kick start this.

cc: @AndyNicks

kavalerov avatar May 26 '21 07:05 kavalerov

Internal Confluence page which is probably our current starting point for writing a standard (internally, at least - there's an argument for us exposing this into public domain in the near future).

QuintinWillison avatar May 26 '21 08:05 QuintinWillison

In https://github.com/ably/ably-common/pull/88 we have defined template layouts for README.md and CONTRIBUTING.md, hosted here.

Those documents need conforming in this repository.

This is also a good opportunity to review what's currently here.

Relates to https://github.com/ably/ably-flutter/issues/110.

QuintinWillison avatar Jul 20 '21 16:07 QuintinWillison