Closed yatendra2001 closed 1 year ago
@Sing-Li Just a quick question on point 1: Do I cover monorepo build instructions in README.md or CONTRIBUTING.md? WDYT?
(how to build both, how to build one, where to find artifacts, where to find error logs, how it integrates with Github Action CI, and where to find logs if CI fails)
I guess above questions might make more sense in CONTRIBUTING.md
Breakout links and point 2&3 are much needed for sure.
Good idea. CONTRIBUTING.md is a good home for it. 👏
I think instructions and docs will inevitably get complex, with time, for this project. That's a very good suggestion!
@Sing-Li ,
I have addressed your feedback and made the following updates:
Expanded the main CONTRIBUTING.md file to cover monorepo build instructions for both artifacts, including how to build them individually and together, where to find artifacts, where to find error logs, and how the build process integrates with GitHub Actions CI.
I have also added breakout links to the package-specific README.md files.
Created a detailed README.md file for the EmbeddedChat package, which includes a description of the project, build instructions for the package, and information on where to find artifacts and error logs.
Created a detailed README.md file for the API package, which includes a description of the project, build instructions for the package, and information on where to find artifacts and error logs.
Thank you for your guidance!
Yeah exactly, needed to change a few names of directories in order to be consistent with Melos and CI. Thanks!
Description
This PR adds comprehensive documentation for the
Rocket.Chat Flutter SDK
as well as a CONTRIBUTING.md file for the entire monorepo.Changes:
These changes aim to make it easier for new contributors to get started with the project and to provide clear instructions on how to use each package.
Related Issue
4