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: transfer sdk principles and best practices #59

Merged
merged 1 commit into from
Sep 6, 2024

Conversation

ttypic
Copy link
Contributor

@ttypic ttypic commented Jun 20, 2024

Transferred 'Client Software (SDK) Principles and Best Practices' from Confluence to GitHub to increase visibility for changes and make it easier to maintain. All changes from now on will be done using PRs to this repo.

Copy link

@VeskeR VeskeR left a comment

Choose a reason for hiding this comment

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

Couple of comments and questsions:

How do we want to handle unresolved inline comments fron the original doc? There are quite a lot of them actually, 33 comment threads total. Also 2 page comments with suggestions for overall structure.


Should also update https://github.com/ably/engineering/blob/main/best-practices/README.md and add a link to this new sdk-principles page.


Need to fix linter erros https://github.com/ably/engineering/actions/runs/9596867014/job/26464675936

best-practices/sdk-principles.md Outdated Show resolved Hide resolved
best-practices/sdk-principles.md Outdated Show resolved Hide resolved
best-practices/sdk-principles.md Outdated Show resolved Hide resolved
@ttypic ttypic force-pushed the tranfer-sdk-principles branch from 4fafc79 to d4d2e08 Compare August 27, 2024 20:57
@ttypic ttypic force-pushed the tranfer-sdk-principles branch from d4d2e08 to 99b17a9 Compare September 6, 2024 11:46
Transferred 'Client Software (SDK) Principles and Best Practices' from Confluence to GitHub to increase visibility for changes and make it easier to maintain. All changes from now on will be done using PRs to this repo.
@ttypic ttypic force-pushed the tranfer-sdk-principles branch from 99b17a9 to 0a19569 Compare September 6, 2024 11:49
@ttypic ttypic requested a review from VeskeR September 6, 2024 11:51
Copy link

@VeskeR VeskeR left a comment

Choose a reason for hiding this comment

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

LGTM

@ttypic ttypic merged commit b04959c into main Sep 6, 2024
1 check passed
@ttypic ttypic deleted the tranfer-sdk-principles branch September 6, 2024 20:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants