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

Fixed: Typos in README.md #5119

Closed
sg7801 opened this issue Jun 19, 2021 · 9 comments · Fixed by backdrop/backdrop#3649
Closed

Fixed: Typos in README.md #5119

sg7801 opened this issue Jun 19, 2021 · 9 comments · Fixed by backdrop/backdrop#3649

Comments

@sg7801
Copy link

sg7801 commented Jun 19, 2021

There are some typos in the documentation ( some grammatical errors and some typing mistakes)

@indigoxela
Copy link
Member

@sg7801 Now I get it, there was no pre-existing issue for that, you acted proactively. 😼

@sg7801
Copy link
Author

sg7801 commented Jun 19, 2021

I directly came to the project and saw errors in documentation, hence I started contributing by correcting the documentation.

@klonos
Copy link
Member

klonos commented Jun 19, 2021

Thanks you @sg7801 🙏🏼 ...please see my comment in the PR re webserver vs web server. Otherwise, looks good 👍🏼

@klonos klonos added this to the 1.19.2 milestone Jun 19, 2021
@klonos klonos changed the title Typos in Documentation Typos in README.md Jun 19, 2021
@stpaultim
Copy link
Member

@sg7801 - Thanks for jumping in and offering a PR. We appreciate it!

@indigoxela
Copy link
Member

@sg7801 sorry for the delay and many thanks for your patience. 🙏 Currently your pull request conflicts with existing code, as the README got updated recently.

Do you know how to resolve git conflicts? Please let us know, if you need guidance or help.
Or, if you prefer to create a fresh pull request, based on the updated README, just do so.

@sg7801
Copy link
Author

sg7801 commented Jul 15, 2021

@indigoxela I would be great if you would guide me a bit on resolving git conflicts.

@indigoxela
Copy link
Member

indigoxela commented Jul 15, 2021

I would be great if you would guide me a bit on resolving git conflicts.

Hm, I just saw that you made the changes in your fork on the 1.x branch - that's impractical in this case. A new PR would be much easier.

I don't know which IDE you use, so I give an example for command line, for the whole fork-edit-push-pull_request process.

  1. Fork the project on Github (as you did) and clone locally
  2. Create a local branch for your change: git branch your-name-describes-problem
  3. And checkout that branch with git checkout your-name-describes-problem
  4. Work locally on that branch to fix the problem
  5. git push - git will nag, but provide the correct command that includes the upstream setting 😏
  6. Run that command - that will output a link to create a PR
  7. Create that PR (from your branch)

Time passes, someone was faster, changes to that file already got merged...

  1. Checkout 1.x on your local dev - note, you didn't touch that, you worked on a branch
  2. git remote add upstream https://github.com/backdrop/backdrop.git this adds the original backdrop repo as additional remote named "upstream" (the name can be different - your choice)
  3. git fetch upstream get the updated code from the original repo
  4. git merge upstream/1.x merge that into your own 1.x branch
  5. git push origin 1.x push that to your fork on Github

Now resolve the conflict:

  1. git checkout your-name-describes-problem
  2. git rebase 1.x put your changes on top of the updated code from the original repo
  3. ... ouch a conflict ...
  4. Follow the instructions you get from git
  5. Probably you have to edit files manually
  6. git add the-conflicting-file
  7. git rebase --continue
  8. Repeat if necessary until the rebase gets finished
  9. git push -f push your changes to your branch on Github

BUT ... as you did your changes directly on your 1.x branch, you better:

  1. Close your pull request
  2. Delete your fork
  3. Create a fresh fork
  4. Create a branch with git branch your-name-describes-problem
  5. Checkout that branch with git checkout your-name-describes-problem
  6. Add your changes again
  7. ...

I don't know if that's really helpful, maybe someone else can provide a much easier step-by-step guide. 😀

Again, I'd recommend to start fresh. And this time you work on a branch, so it's easier to add an upstream and get your fork up-to-date with the original repo.

@quicksketch quicksketch modified the milestones: 1.19.2, 1.19.3 Jul 21, 2021
@jenlampton jenlampton modified the milestones: 1.19.3, 1.19.4 Aug 12, 2021
@quicksketch quicksketch modified the milestones: 1.19.4, 1.20.1 Sep 15, 2021
@quicksketch quicksketch modified the milestones: 1.20.1, 1.20.2 Oct 11, 2021
@jenlampton jenlampton modified the milestones: 1.20.2, 1.20.3 Nov 18, 2021
@quicksketch quicksketch modified the milestones: 1.20.3, 1.20.4 Dec 3, 2021
@herbdool
Copy link

I think it's ready to be merged. Thank you @sg7801

@ghost
Copy link

ghost commented Jan 6, 2022

Many thanks to @sg7801 for this issue/PR! Thanks also to @indigoxela, @klonos & @herbdool for the reviews. I've merged backdrop/backdrop#3649 into 1.x and 1.20.x.

@jenlampton jenlampton changed the title Typos in README.md Fixed: Typos in README.md Jan 15, 2022
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants