Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The instructions in Sending pull requests are not clear enough #21

Open
nanoni17728 opened this issue Jun 22, 2018 · 2 comments
Open

The instructions in Sending pull requests are not clear enough #21

nanoni17728 opened this issue Jun 22, 2018 · 2 comments

Comments

@nanoni17728
Copy link

nanoni17728 commented Jun 22, 2018

I started moving the tutorial over to the Rust WebAssembly template and I'm struggling to follow the instructions from the Sending pull requests section in the readme.

The described steps are more involved than your typical git workflow. But they are written in an ambiguous way and it feels like unless you are a git wizard you won't be able to figure out what to do.

For example the first step tells us to "checkout the branch for the first chapter that needs to be updated". But I never used git checkout to go to the chapter I wanted and cloning the repository using the provided command don't create any branches. I just cded into the corresponding folder since they are submodules and I guess it did the trick.

Since we are dealing with advanced git concepts here I'm not sure it would be an easy task to improve this section. However I think that giving commands which can be copy-pasted is a good starting point, even if the explanations aren't that great.

I will try to report the commands I used to be able to get to the point where I can send my changes when I'll be finished working on my current issue.

I hope the point I'm trying to raise is clear!

@mgattozzi
Copy link
Contributor

Hey @nanoplink, yeah they are ambiguous as we've talked about. I'm going to write up some more detailed instructions here for you later today so you know how to do it. I'll make a note in the future to make sure we clarify instructions more so that even new contributors can tackle issues. git is tough and more advance workflows are alien if you've not done it before :/

@mgattozzi
Copy link
Contributor

As we discussed today and tested out:

git clone [email protected]:nanoplink/wasm_game_of_life.git
cd wasm_game_of_life
git submodule update --init
./update_submodules
git submodule foreach 'git remote add upstream https://github.com:rustwasm/wasm_game_of_life.git'
git submodule foreach 'git remote set-url origin [email protected]:nanoplink/wasm_game_of_life.git'

Then cd into each directory to make changes for each chapter. Then commit in each chapter what you want to change. Then when ready go to the top level on master and add all the chapters and make a commit. Then push that to your branch and open up a PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants