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

Improve the Git Cheat Sheet in Portuguese #328

Merged
merged 10 commits into from
Jul 31, 2015
Merged

Conversation

felipedau
Copy link
Contributor

I did a few interactive rebases to attempt to group the changes, so that if some of them are not accepted, the commits can be easily removed. How do you usually work? Should these all be squashed into one final commit?

Notes

In this PR, I am trying to translate things back to English to explain the changes to everyone. Let me now if I should clarify more.

Title

The previous title did not sound right. The one I propose sounds like GitHub's Git Cheat Sheet.

Use Remote Repository instead of Marker

I do not know where those were taken from, but it is very confusing to use Marker for Remote.

Use Prepare and Monitor

These changes were taken from Pro Git's translation, which IMO sound much better:

  • I found that Select was being used for Stage, but it sounds too vague and there is no direct translation for that. On section 1.3, I noticed they used Prepare, which makes it a lot clearer.
  • Track was translated correctly, but after reading section 2.2 it seems that using Monitor describes better what actually happens.

I should point out that there is an inconsistency on the book, and there are sections that the other terms are used as well, probably more than the ones I chose.

Redo commits

The Redo commits section was translated to Undo commits. It seemed wrong, but that title is the one that best describe the section. It consists only of git reset commands, where you just undo commits. Maybe this is actually something that should be changed in the English version.

Mentioning pt-BR

I did not mention that the cheat sheet is in Brazilian Portuguese because it would not follow the same template of the others. What if it all of them had to mention what languages they were written?

Thanks!

@brntbeer
Copy link
Member

How do you usually work? Should these all be squashed into one final commit?

0 issues with workflows. Don't care if they're rebased together (though a proper story with commits is always appreciated). I typically dont like to squash all my commits into one final commit, because it doesn't tell a good story. If you wanted to do that, i wouldnt stop you.

@brntbeer
Copy link
Member

What if it all of them had to mention what languages they were written?

I think mentioning that it's in Brazilian Portuguese on the document itself is important, though i don't know about changing the folder to be pt-br. What are your thoughts?

The Redo commits section was translated to Undo commits

I like the this change to 'undo' personally.

All of those change sound reasonable, using https://git-scm.com as a comparison is a great idea.

@felipedau
Copy link
Contributor Author

0 issues with workflows. Don't care if they're rebased together (though a proper story with commits is always appreciated). I typically dont like to squash all my commits into one final commit, because it doesn't tell a good story. If you wanted to do that, i wouldnt stop you.

I agree with you. Doesn't make too much sense to make coherent commits and then
squash them in the end.

I found out I made a mistake and left an accent mark in the file. When I got
back to check if I made the same for others, I found another one from previous
versions. I created a new commit to fix those, but I could also rebase to squash
it into two of my commits:

  • Keep consistency for "Specified": properly change the word and remove the
    accent I left
  • Fix capitals, articles and accent marks: fix the other accent issue from
    previous versions

What do think?

I think mentioning that it's in Brazilian Portuguese on the document itself is
important, though i don't know about changing the folder to be pt-br. What are
your thoughts?

Well, that's not really necessary because in the end we all know if that's
"our" Portuguese or not, but you could rename the directory to pt_BR to keep
it consistent with the es_ES you already have there and changing the title to
GitHub's Git Cheat Sheet (pt-BR) should be enough.

I like the this change to 'undo' personally.

Well, --amend could be added so that Redo makes sense. I am not sure how that would impact the layout though.

All of those change sound reasonable, using https://git-scm.com as a comparison is a great idea.

Thanks!

Sorry for the mess, I gotta find out why I can't (or how to) use Markdown when replying via email :(

@brntbeer
Copy link
Member

Dont worry about the mess @felipedau! it looks fine to me. The reason the markdown doesnt look the best from email responses is because we sanitize it a bit.

As for the accent marks, go ahead and fix them. Great find on those too. i definitely didnt notice with my untrained 👀 👍

GitHub's Git Cheat Sheet (pt-BR) should be enough.

Yeah, let's do that. sounds like a great fix!! thank you soo much

@felipedau
Copy link
Contributor Author

Dont worry about the mess @felipedau! it looks fine to me.

In preview that post looks pretty cool haha

The reason the markdown doesnt look the best from email responses is because we sanitize it a bit.

Ohh, got it. I'll go back to the website mode.

Yeah, let's do that. sounds like a great fix!!

Cool! I can rename the directory and the title. I believe the only file that mentions the cheat sheets is index.html:

    <div class="col-md-7">
      <h3>Cheat Sheets</h3>
      <p>
        Looking for a quick reference sheet of Git commands or migration from SVN?<br>
        We've got just the documents, available for download in these languages:</p>
      <div class="col-md-3">
        <h4>Git</h4>
        <p><a href="downloads/github-git-cheat-sheet.pdf"><span class="octicon octicon-cloud-download"></span> English</a></p>
        <p><a href="downloads/es/github-git-cheat-sheet.pdf"><span class="octicon octicon-cloud-download"></span> Spanish</a></p>
        <p><a href="downloads/fr/github-git-cheat-sheet.pdf"><span class="octicon octicon-cloud-download"></span> French</a></p>
        <p><a href="downloads/ja/github-git-cheat-sheet.pdf"><span class="octicon octicon-cloud-download"></span> Japanese</a></p>
        <p><a href="downloads/pt/github-git-cheat-sheet.pdf"><span class="octicon octicon-cloud-download"></span> Portugues</a></p>
        <p><a href="downloads/cn/github-git-cheat-sheet.html"><span class="octicon octicon-cloud-download"></span> Chinese</a></p>
      </div>
      <div class="col-md-4 pull-right">
        <h4>SVN Migration</h4>
        <p><a href="downloads/subversion-migration.html"><span class="octicon octicon-cloud-download"></span> English</a></p>
      </div>
    </div>

I can also change the path and rename the link to Brazilian Portuguese to keep consistency.

thank you soo much

Thank YOU! You've been totally friendly, helpful and open to suggestions :)

@brntbeer
Copy link
Member

I can rename the directory and the title.

Not sure if i would changed the directory to pt-br though. Would it be too shocking of a difference if anyone saw it was pt and then the title was pt-br? i guess im curious if it makes sense to keep both or just keep pt-br if it's more popular, and change the directory to be more honest

@felipedau
Copy link
Contributor Author

Not sure if i would changed the directory to pt-br though. Would it be too shocking of a difference if anyone saw it was pt and then the title was pt-br? i guess im curious if it makes sense to keep both or just keep pt-br if it's more popular, and change the directory to be more honest

From a user's perspective, I wouldn't even know the name of the directory, I guess.

I just suggested that because as we were already changing the title, the directory could be renamed as well to follow the same pattern, since there is an es_ES there. It doesn't look like it's being used though.

I'm good with any of the options (renaming the directory or not).

@brntbeer
Copy link
Member

Let's keep it inside of the pt directory for now. Because that file has existed for a while and we do not have redirects, let's just keep the expected behavior, but let people know when opening the cheat sheet that it's pt-br.

@felipedau
Copy link
Contributor Author

Because that file has existed for a while and we do not have redirects, let's just keep the expected behavior, but let people know when opening the cheat sheet that it's pt-br.

Ohh, right. I didn't even think about that.

Well, I squashed that extra commit I did for the accent marks and clarified it's pt-BR. I had to use --force to push these latest changes, but as it's a PR I do not think it's a problem.

@brntbeer
Copy link
Member

Really love that latest commit. If you think this is good to go, I think it's good to go.

thanks for working with me on this, such a pleasure. 👍

@felipedau
Copy link
Contributor Author

Really love that latest commit. If you think this is good to go, I think it's good to go.

Me too. I'm pretty happy with the update. It's good to go :)

thanks for working with me on this, such a pleasure. 👍

Thanks, it's mutual!

This kit you guys made is great! Thank you for providing it.

brntbeer added a commit that referenced this pull request Jul 31, 2015
Improve the Git Cheat Sheet in Portuguese
@brntbeer brntbeer merged commit 61ecb66 into github:master Jul 31, 2015
@shana
Copy link

shana commented Jul 31, 2015

Thanks for adding the pt-BR note! As a pt-PT speaker, reading pt-BR is somewhat painful at times, and it's sad that a lot of companies don't make the distinction between these variants. I would be happy to help make the pt-PT variant 😄

@brntbeer
Copy link
Member

@shana we'd never turn down anyone sending changes or pull requests. if you want to add a pt-PT version, i would encourage it.

if that happens, we'll rename this one and set up redirects, etc

@felipedau
Copy link
Contributor Author

I don't really speak pt-PT, but if there's anything I can help, let me know!

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

Successfully merging this pull request may close these issues.

None yet

3 participants