chore: update Readme for submodules install #472
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Added two lines to speedup the process for other newbies, so that the common submodule is automatically installed, and they don't run into zsh bracket issues 😅
Since I wanted to contribute, and I know this as a common easy way, I added a view lines for this in the Readme
ravinkohli reviewed Aug 17, 2022
Comment on lines +47 to +52
| Clone the repository with submodules | ||
| ```sh | ||
| | ||
| git clone --recurse-submodules git@github.com:automl/Auto-PyTorch.git | ||
| | ||
| ``` |
There was a problem hiding this comment.
Suggested change
| Clone the repository with submodules | |
| ```sh | |
| git clone --recurse-submodules git@github.com:automl/Auto-PyTorch.git | |
| ``` |
There was a problem hiding this comment.
Could you add these lines under ## Manual Installation from line no. 71?
ravinkohli suggested changes Aug 17, 2022
There was a problem hiding this comment.
Thanks for this PR, but unfortunately we won't be able to merge this one as it is directed towards master. Therefore I am closing this PR. I suggest you checkout a new branch from the development branch and resubmit this PR. I have also left some minor comments.
ravinkohli reviewed Aug 17, 2022
| | ||
| ### Community Contribution | ||
| 1. Fork the Repository into your account | ||
| 2. create a `feature` or `bug` sub-branch e.g. `git checkout -b feature/name_of_feature` |
There was a problem hiding this comment.
As stated in line 210, we would like the users to check out new branches from the development branch. I suggest that you unify ## Contributing and ### Community Contribution.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Description
Motivation and Context
Simplify the "getting-started" 🚀
How has this been tested?
☑ Tested with a new clone/install