[fix] correct readme on main branch for easier instructions, create CONTRIBUTING.md file #706
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
Create a CONTRIBUTING.md file for the main branch, to be copied later to the gh-pages branch and referred to in the README.md file in the main branch.
Under the contribute section, I've added a hyperlink that links to the CONTRIBUTING.md file which users can check out if they need more detailed instructions.
|
Thanks for opening this pull request! Do join our Github Org, a Community inclusive for Data Science Enthusiasts 😄 |
sanjay-kv
approved these changes
Oct 9, 2024
|
Congrats on merging your first pull request! Do join our Github Org, a Community inclusive for Data Science Enthusiasts 😄 |
|
Anytime @sanjay-kv |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Description
This PR corrects the readme on the
mainbranch by making users switch to the working branchgh-pagesbranch before creating a new branch to add the feature, this is to ease the process of adding a new feature for beginners who don't understand the ins and outs of git on the CLI, addressing issue #683. Now I've created the CONTRIBUTING.md file to be put into themainbranch as well as linked to it on the readme page using a hyperlink.