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

update README.md #107

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

update README.md #107

wants to merge 1 commit into from

Conversation

Marco2018
Copy link

@Marco2018 Marco2018 commented Jan 18, 2019

README.md: Fix docstring typo

avoid -->avoiding

Closes #99

Copy link
Member

@shashank-b shashank-b left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @Marco2018
The change looks fines, but I'd suggest you do the following things:

  • Go through the commit guidelines.
  • Go through the newcomer's guide.
  • After reading them, squash your commits.
  • Modify your commit message as per the other examples given in the guidelines.
  • Refer the issue in the PR description (its hard to follow the trail otherwise).
  • Be sure to not make the changes from your master branch later on (it can lead to some complications). You don't need to change this for this PR though.
  • Make all the changes in the current PR and don't create another one.

After all this is done, someone would merge your PR 🙂

@Marco2018
Copy link
Author

Hi @shashank-b
Thank you for your suggestions. It is my first time to contribute in an open source project. I will go through commit guidelines and newcomer's guide and modify it afterward. Thanks!

@Marco2018
Copy link
Author

Hi @shashank-b
I have read both commit guidelines and newcomer's guide and modified my commit message as you suggested. But I am not sure how to squash my commits. Can I just fork this project to my Github once again?
Thanks, it's my first time to make a PR. I really appreciate your help.

Copy link

@KVGarg KVGarg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Marco2018 Check coala git basics to know how can squashing of commits be done!

@Marco2018
Copy link
Author

Marco2018 commented Mar 23, 2019

Hey! @KVGarg Thank you for your help. I have tried to squash my commits into one. So I reset back the branch and commit once again. It seems commits are squashed into one commit. Is it acceptable for this PR? So sorry I made this PR a little bit complicated. THX!

avoid-->avoiding
Closes coala#99
@KVGarg
Copy link

KVGarg commented Mar 24, 2019

Yeah @Marco2018
For further any changes to existing commit you can use git commit —amend to avoid creating more than one commit for a PR/issue

@Marco2018
Copy link
Author

@KVGarg Thanks!

Copy link
Member

@utkarsh2102 utkarsh2102 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Me likey! 👍🏻
Although you need a rebase or @abhishalya can do that & merge?

@abhishalya
Copy link
Member

Won't be able to rebase as the PR was created from master. @Marco2018 please rebase if you can.

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

Successfully merging this pull request may close these issues.

README.md: Update grammar at line 97
6 participants