RocketChat / Rocket.Chat.Flutter.SDK

Easily integrate Rocket.Chat into all your Flutter projects
MIT License
12 stars 4 forks source link

[to-do] add targeted contributor-friendly documentation #4

Closed Sing-Li closed 1 year ago

Sing-Li commented 1 year ago

We need to add documentation, in a manner consistent across the entire monorepo, for our targeted segment of contributors. This will help to grow the community of contributors to the SDK project.

Making it easy to onboard and get contributing should be priority one (for all contributors with enough required skill - our target).

yatendra2001 commented 1 year ago

@Sing-Li, I have created a pull request that adds the README and CONTRIBUTING files to the project. The README file provides an overview of the SDK, its features, and basic setup instructions. The CONTRIBUTING file contains guidelines for contributors and instructions on how to set up the development environment.

With these files in place, I believe it will be easier for new contributors to get started with the project and understand how they can contribute effectively. Please review the pull request and let me know if any changes are needed to make the onboarding process as smooth as possible for potential contributors.

Sing-Li commented 1 year ago

Thanks again @yatendra2001 I will comment inline there on the PR.

yatendra2001 commented 1 year ago

@Sing-Li I think we can close this issue now. Merged PR: #5

Sing-Li commented 1 year ago

Thanks.