From be294235bb1ad1ad4aad99fda6eabd6c637bb9e6 Mon Sep 17 00:00:00 2001 From: "C.C." Date: Thu, 2 Jan 2025 09:47:02 +0800 Subject: [PATCH] Improve documentation for YoMo Update `docs/README.md` to include contribution guidelines. * **Contributing Section** - Add a new section titled "Contributing" with steps for contributing to the YoMo documentation. - Include guidelines for making clear and concise changes, following the existing structure, testing changes locally, and providing detailed descriptions in pull requests. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/yomorun/yomo?shareId=XXXX-XXXX-XXXX-XXXX). --- docs/README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/README.md b/docs/README.md index f02719db3..84fa1819b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -19,3 +19,22 @@ pnpm install --frozen-lockfile pnpm dev ``` + +## Contributing + +We welcome contributions to the YoMo documentation! If you would like to contribute, please follow these steps: + +1. Fork the repository on GitHub. +2. Create a new branch for your changes. +3. Make your changes and commit them with clear and concise commit messages. +4. Push your changes to your forked repository. +5. Open a pull request to the main repository. + +### Guidelines + +- Ensure that your changes are clear and concise. +- Follow the existing structure and organization of the documentation. +- Test your changes locally to ensure they render correctly. +- Provide a detailed description of your changes in the pull request. + +Thank you for contributing to the YoMo documentation!