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 #5

Merged
merged 1 commit into from
Jun 14, 2024
Merged

Conversation

karanb01
Copy link
Contributor

I am new to GitHub , Kindly Review the changes , as I am learning Forking, committing and pull request through this.

I am new to GitHub , Kindly Review the changes , as I am learning Forking, committing and pull request through this.
Copy link
Owner

@AnimeshKumar923 AnimeshKumar923 left a comment

Choose a reason for hiding this comment

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

You're welcome to practice your knowledge through this repo! @karanb01
The changes looks good to me.

Some general things to keep in mind which I've experienced:

  • First thing is the PR description that pops in front of you when you open a new PR in any repo. In that description, you should describe what this PR addresses, which issue it resolves (no issue in this case which is fine, minor changes can be directly made without opening issue, but for proposing new ideas or when suggesting major changes you should first open an issue and then a corresponding PR to address that issue) and any more info that may seem relevant.
    By default it fills the description according to the first commit that you've made which I can see is the case with yours.

  • Your commit message should describe what changes are being made through each commit. (Although, in this case, it's simple and self-explanatory that you're updating the README file) Sometimes when you're working on more complex PRs, there are times when you should include a good commit message which describes what changes is being made with each PR. That way if you come later and see the commits you get that what exact changes were made through that specific commit, which is helpful in various scenarios.
    It is similar to how you write comments in the code, but this time through Git.

  • For example, you can checkout these PRs of mine for reference: 1 2. Take a look on how the commits are being made.

Providing some additional link to docs for better understanding on this matter:

These articles should be enough to get started 👍
Hope it helps! Happy contributing! 🙌

@AnimeshKumar923
Copy link
Owner

@karanb01 what tool are you using to push your changes to GitHub?

@karanb01
Copy link
Contributor Author

@karanb01 what tool are you using to push your changes to GitHub?

Tools :)....

@karanb01 karanb01 closed this Jun 14, 2024
@karanb01 karanb01 reopened this Jun 14, 2024
@AnimeshKumar923 AnimeshKumar923 merged commit 554b94c into AnimeshKumar923:main Jun 14, 2024
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.

2 participants