Contribution Guidelines Added & Documentation Improved #184
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
With a detailed workflow of the steps to contribute
Contributor
Author
|
@DenverCoder1, Do let me know your review. |
DenverCoder1
reviewed
Oct 6, 2021
Owner
DenverCoder1
left a comment
DenverCoder1
left a comment
There was a problem hiding this comment.
Thanks for contributing this! Great explanation.
I just have a few very minor suggestions.
Contributor
Author
|
Did the necessary changes as per your suggestion. |
DenverCoder1
reviewed
Oct 6, 2021
Owner
DenverCoder1
left a comment
DenverCoder1
left a comment
There was a problem hiding this comment.
Still a couple things that weren't changed yet
CONTRIBUTING.md
Outdated
|
|
||
| ### Need some help regarding the basics? | ||
|
|
||
| You can refer to the following articles on basics of Git and Github in case you are stuck: |
Owner
There was a problem hiding this comment.
Suggested change
| You can refer to the following articles on basics of Git and Github in case you are stuck: | |
| You can refer to the following articles on the basics of Git and GitHub in case you are stuck: |
CONTRIBUTING.md
Outdated
Comment on lines
153
to
154
| # This message get associated with all files you have changed | ||
| git commit -m "message" |
Owner
There was a problem hiding this comment.
Suggested change
| # This message get associated with all files you have changed | |
| git commit -m "message" | |
| # This message will get associated with all files you have changed | |
| git commit -m "message" |
CONTRIBUTING.md
Outdated
Comment on lines
172
to
178
| - Go to your forked repository in your browser and click on "Compare and pull requests". Then add a title and description to your pull request that explains your contribution. | ||
|
|
||
| <img width="700" alt="compare and pull request" src="https://user-images.githubusercontent.com/63443481/136186304-c0a767ea-1fd2-4b0c-b5a8-3e366ddc06a3.PNG"> | ||
|
|
||
| <img width="882" alt="opening pull request" src="https://user-images.githubusercontent.com/63443481/136186322-bfd5f333-136a-4d2f-8891-e8f97c379ba8.PNG"> | ||
|
|
||
| - Voila! Your Pull Request has been submitted and it's ready to be merged.🥳 <br /> |
Owner
There was a problem hiding this comment.
Suggested change
| - Go to your forked repository in your browser and click on "Compare and pull requests". Then add a title and description to your pull request that explains your contribution. | |
| <img width="700" alt="compare and pull request" src="https://user-images.githubusercontent.com/63443481/136186304-c0a767ea-1fd2-4b0c-b5a8-3e366ddc06a3.PNG"> | |
| <img width="882" alt="opening pull request" src="https://user-images.githubusercontent.com/63443481/136186322-bfd5f333-136a-4d2f-8891-e8f97c379ba8.PNG"> | |
| - Voila! Your Pull Request has been submitted and it's ready to be merged.🥳 <br /> | |
| - Go to your forked repository in your browser and click on "Compare and pull request". Then add a title and description to your pull request that explains your contribution. | |
| <img width="700" alt="compare and pull request" src="https://user-images.githubusercontent.com/63443481/136186304-c0a767ea-1fd2-4b0c-b5a8-3e366ddc06a3.PNG"> | |
| <img width="882" alt="opening pull request" src="https://user-images.githubusercontent.com/63443481/136186322-bfd5f333-136a-4d2f-8891-e8f97c379ba8.PNG"> | |
| - Voila! Your Pull Request has been submitted and it's ready to be merged. 🥳 |
CONTRIBUTING.md
Outdated
|
|
||
| ### Step 1 : Fork the Project | ||
|
|
||
| - Fork this repository. This will create a copy of this repository on your Github profile. |
Owner
There was a problem hiding this comment.
Suggested change
| - Fork this repository. This will create a copy of this repository on your Github profile. | |
| - Fork this repository. This will create a copy of this repository on your GitHub profile. |
Contributor
Author
|
Done. |
DenverCoder1
approved these changes
Oct 6, 2021
Owner
DenverCoder1
left a comment
DenverCoder1
left a comment
There was a problem hiding this comment.
Great! Thanks for contributing! 🎉
|
Coded |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As per the things mentioned in #183, I have updated the
CONTRIBUTING.mdfile.Added a detailed workflow of the steps to contribute to this open-source project.
Fixes #183
Type of change
Checklist:
Screenshots
Attaching 1 screenshot for reference.
