First-contributions: Tutorial is specific for users of *nix platform and git command line tool

Created on 23 Feb 2017  路  19Comments  路  Source: firstcontributions/first-contributions

馃悶 Problem

Currently the tutorial aims only at people using Linux or macOs operating system and who uses command line git tool.
It might be good to entertain users who don't fall in to this category too.

馃幆 Goal

Address users across platforms and tools. We can have multiple versions of the tutorial and link each of them in main Readme.

馃搵 Steps to solve the problem

  • Learn how to submit a pull request if you haven't done that already (just follow the tutorial in Readme)
  • Find a platform/tool from the list below which has checkbox unchecked 馃敳
  • Comment below about what you've started working on.
  • Make a separate file for the tutorial and add a link to it in all Readme files (Include translation files)
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #80
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project 馃帀

馃搵 Operating system/ tool for which tutorial should be added

  • [x] Windows
  • [x] Github desktop app
  • [x] GitKraken WIP

If the tool or operating system you use is not listed, please comment below. We'll add it

@Thrasheristico had previously put a comment about this in #79

enhancement good first issue help wanted

All 19 comments

If anyone wants to have a peek at what I've got so far: https://github.com/suttonwilliamd/first-contributions/blob/gitkraken-guide/gitkraken.md

I'm sure I need some help with design/layout. I tried to keep as much of the structure, language and even screenshots that are relevant. Thanks for any help! :)

@suttonwilliamd, As you're writing tutorial for a GUI tool, make sure that you have screenshots of all relevant actions with point of action (let it be a button or textbox) annoted.

I'll help in case you need changes in layout or styling. Give it your best

I would love to take a shot at writing the tutorial for the Github desktop app. I used it to add my name to the contributor's list and took screenshots along the way.

@crawleya go ahead. May the source be with you.

I can do the Windows / Visual Studio 2015 platform. It will be screen-shot heavy, so please be patient!

@ramseyjacob: Awesome. Thank you for taking this up. Please feel free to reach out to me in case of any questions. I'll try to take a look at your changes whenever I get time and share my thoughts

I'm going to use Visual Studio 2017 Community since it just officially launched today, if that's good with you.

@ramseyjacob: I'm good with that.

image

:-)

One question: In the section of the tutorial called "Keeping your fork synced with this repository", is the point to show people how to keep their fork's master branch in sync with your master branch? In the top section they create a branch for adding their name, then work with that branch until the pull request. If they don't do anything else, their current branch remains that new add-name branch. Should they switch back to master before performing the Sync section?

If they execute git rebase upstream/master while the active branch is still their add-name branch, that will rebase add-name to upstream/master, right?

Edit: I think I already confirmed this for myself. I will add a step to my tutorial to check out master before performing the git fetch upstream.

Another question: The links to translations are actually links to translations of the command line README.md. My new tutorial hasn't been translated yet.

I am planning to remove these links from my tutorial and maybe they can be added back if a kind soul should translate my tutorial someday.

Do you agree with this approach?

Please have a look at my first round of work. Lots more to come, but this has set the skeleton of the ideas I'm throwing around.

https://github.com/ramseyjacob/first-contributions/tree/windows-vs2017-tutorial

is the point to show people how to keep their fork's master branch in sync with your master branch?

Yes

If they don't do anything else, their current branch remains that new add-name branch. Should they switch back to master before performing the Sync section?

Yes. This is something I missed until now. I can't thank you enough for pointing this out. We'll have to add this to all tutorials

I think I already confirmed this for myself. I will add a step to my tutorial to check out master before performing the git fetch upstream.

Awesome. I'll change other ones as well

I am planning to remove these links from my tutorial and maybe they can be added back if a kind soul should translate my tutorial someday.

Yes. You're right. Go ahead and remove it

@ramseyjacob: I need some advice from you.

I'm wondering if users of windows OS uses any other tool for version control.

The tutorial you added was about workflow in visual studio right? Are there any other tools (maybe command line) that we should cover in windows?

@Roshanjossey: The command line tutorial was good for Windows users as well - the commands are the same AFAIK.

The GitHub Desktop tutorial by @crawleya works on Windows, too, I believe, so already there are good options for Windows devs!

@ramseyjacob, cool. I'll check off the windows option then. We shall add anything if there is demand from community

Hey everyone! I took some screenshots and updated the GitKraken guide a bit. It's almost ready. I need a few more eyes on it though. Would anyone care to give it a dry run?

https://github.com/suttonwilliamd/first-contributions/blob/gitkraken-guide/gitkraken-tutorial.md

Thanks for any feedback

@suttonwilliamd: I had a quick look at it. Looks good.

One quick feedback: Could you add link to GitKraken guide to main Readme as well?

I'll spend some time later today to have a detailed read.

Meanwhile, you can submit a PR. we can do reviews and comments there.

Addressed this with PR #108

@suttonwilliamd, As all tools and operating systems that we identified has been covered, I think we can close this card.

If anyone needs to add any other platforms/OS, we're good to open this issue again.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

sara-02 picture sara-02  路  9Comments

TomerPacific picture TomerPacific  路  11Comments

palash25 picture palash25  路  5Comments

als1 picture als1  路  13Comments

Haozhe321 picture Haozhe321  路  5Comments