-
Notifications
You must be signed in to change notification settings - Fork 52
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
code structure reference updated with new changes #147
code structure reference updated with new changes #147
Conversation
README.md
Outdated
- * [➤ How it Works](#how-it-works) | ||
- * [➤ Contributing to Trapheus](#contributing-to-trapheus) | ||
- * [➤ Contributors](#contributors) | ||
- - [➤ Pre-Requisites](#pre-requisites) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Madhura-saw did you make these changes? they seem to be unrelated to your PR.
Ideally i was expecting a diff only from this line https://github.com/intuit/Trapheus/pull/147/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R243
Can we please remove the unrelated changes to make this easier for review?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, I did not make any changes over there
README.md
Outdated
@@ -239,20 +240,55 @@ Reference Code Structure | |||
|
|||
```bash | |||
|
|||
├── CONTRIBUTING.md <-- How to contribute to Trapheus | |||
├── CHANGELOG.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can remove CHANGELOG.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sure
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove the large diff from the file since they are not related to given issue
I am sorry but I didn't understand what you meant here |
@Madhura-saw if you see the changes/diff in the files, there are lot of changes unrelated your PR. Can you try taking the latest code and rebase so that the PR shows only your changes accurately? |
yes, on it |
I have made a new commit, I think the previous changes were because when I saved the file in vscode it applied some formatting on it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@Madhura-saw Thank you for your first contribution to Trapheus! I have added the required hacktoberfest labels as well. |
Thank you :) |
Description
In this PR I have modified the code structure reference in the README.md file. The following are the key changes made in the code structure:
events
referencetests/unit
pathdocs
path and a description for itinstall.py
,setup.py
andrequirements.txt
screenshot
referencelabs
andpresentation
referenceCONTRIBUTION.md
withCHANGELOG.md