From 039091c5d45781bdf8216d5ddb9e5568f8f2dc02 Mon Sep 17 00:00:00 2001 From: Millun Atluri Date: Thu, 20 Jul 2023 13:16:55 +1000 Subject: [PATCH] Updated frontend docs to be more accurate --- .../contribution_guides/development.md | 26 ++++++++++--------- .../contributingToFrontend.md | 16 +++++++++--- pull_request_template.md | 2 +- 3 files changed, 28 insertions(+), 16 deletions(-) diff --git a/docs/contributing/contribution_guides/development.md b/docs/contributing/contribution_guides/development.md index 584fb5a4ed..59c2b05c0e 100644 --- a/docs/contributing/contribution_guides/development.md +++ b/docs/contributing/contribution_guides/development.md @@ -41,37 +41,39 @@ Before starting these steps, ensure you have your local environment [configured git clone https://github.com/your-GitHub-username/InvokeAI.git ``` -1. Create a new branch for your fix using: +If you're unfamiliar with using Git through the commandline, [GitHub Desktop](https://desktop.github.com) is a easy-to-use alternative with a UI. You can do all the same steps listed here, but through the interface. + +4. Create a new branch for your fix using: ```bash git checkout -b branch-name-here ``` -1. Make the appropriate changes for the issue you are trying to address or the feature that you want to add. -2. Add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index: +5. Make the appropriate changes for the issue you are trying to address or the feature that you want to add. +6. Add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index: ```bash git add insert-paths-of-changed-files-here ``` -1. Store the contents of the index with a descriptive message. +7. Store the contents of the index with a descriptive message. ```bash git commit -m "Insert a short message of the changes made here" ``` -1. Push the changes to the remote repository using +8. Push the changes to the remote repository using ```markdown git push origin branch-name-here ``` -1. Submit a pull request to the **main** branch of the InvokeAI repository. -2. Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so "Added more log outputting to resolve #1234". -3. In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it! -4. Wait for the pull request to be reviewed by other collaborators. -5. Make changes to the pull request if the reviewer(s) recommend them. -6. Celebrate your success after your pull request is merged! +9. Submit a pull request to the **main** branch of the InvokeAI repository. +10. Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so "Added more log outputting to resolve #1234". +11. In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it! +12. Wait for the pull request to be reviewed by other collaborators. +13. Make changes to the pull request if the reviewer(s) recommend them. +14. Celebrate your success after your pull request is merged! If you’d like to learn more about contributing to Open Source projects, here is a [Getting Started Guide](https://opensource.com/article/19/7/create-pull-request-github). @@ -81,7 +83,7 @@ If you need help, you can ask questions in the [#dev-chat](https://discord.com/c For frontend related work, **@pyschedelicious** is the best person to reach out to. -For backend related work, please reach out to **@pyschedelicious, @blessedcoolant** or **@lstein**. +For backend related work, please reach out to **@blessedcoolant**, **@lstein**, **@StAlKeR7779** or **@pyschedelicious**. ## **What does the Code of Conduct mean for me?** diff --git a/docs/contributing/contribution_guides/development_guides/contributingToFrontend.md b/docs/contributing/contribution_guides/development_guides/contributingToFrontend.md index 08f7c69ce7..d1f0fb7d38 100644 --- a/docs/contributing/contribution_guides/development_guides/contributingToFrontend.md +++ b/docs/contributing/contribution_guides/development_guides/contributingToFrontend.md @@ -10,7 +10,7 @@ The UI is a fairly straightforward Typescript React app, with the Unified Canvas being more complex. -Code is located in `invokeai/frontend/web/src` for review. +Code is located in `invokeai/frontend/web/` for review. ## Stack @@ -24,7 +24,7 @@ The API client and associated types are generated from the OpenAPI schema. See A Communication with server is a mix of HTTP and [socket.io](https://github.com/socketio/socket.io-client) (with a simple socket.io redux middleware to help). -[Chakra-UI](https://github.com/chakra-ui/chakra-ui) & Mantine for components and styling. +[Chakra-UI](https://github.com/chakra-ui/chakra-ui) & [Mantine](https://github.com/mantinedev/mantine) for components and styling. [Konva](https://github.com/konvajs/react-konva) for the canvas, but we are pushing the limits of what is feasible with it (and HTML canvas in general). We plan to rebuild it with [PixiJS](https://github.com/pixijs/pixijs) to take advantage of WebGL's improved raster handling. @@ -40,7 +40,17 @@ We encourage you to ping @psychedelicious and @blessedcoolant on [Discord](http ### Dev Environment -Install [node](https://nodejs.org/en/download/) and [yarn classic](https://classic.yarnpkg.com/lang/en/). +**Setup** + +1. Install [node](https://nodejs.org/en/download/). You can confirm node is installed with: +```bash +node --version +``` +2. Install [yarn classic](https://classic.yarnpkg.com/lang/en/) and confirm it is installed by running this: +```bash +npm install --global yarn +yarn --version +``` From `invokeai/frontend/web/` run `yarn install` to get everything set up. diff --git a/pull_request_template.md b/pull_request_template.md index 04d9a96a99..7a0203ef92 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -5,7 +5,7 @@ - [ ] Bug Fix - [ ] Optimization - [ ] Documentation Update -- [ ] Community Node +- [ ] Community Node Submission ## Have you discussed this change with the InvokeAI team?