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

code structure reference updated with new changes #147

Merged
merged 2 commits into from
Oct 1, 2023

Conversation

Madhura-saw
Copy link
Contributor

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:

  1. Removed the events reference
  2. Added the completed updated structure under the tests/unit path
  3. Added the docs path and a description for it
  4. Added install.py, setup.py and requirements.txt
  5. There was a typo in the screenshot description which I corrected
  6. I have also updated the screenshot reference
  7. I have added the path for the labs and presentation reference
  8. Replaced the CONTRIBUTION.md with CHANGELOG.md

README.md Outdated
- * [➤ How it Works](#how-it-works)
- * [➤ Contributing to Trapheus](#contributing-to-trapheus)
- * [➤ Contributors](#contributors)
- - [➤ Pre-Requisites](#pre-requisites)
Copy link
Collaborator

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?

Copy link
Contributor Author

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
Copy link
Collaborator

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sure

README.md Show resolved Hide resolved
Copy link
Collaborator

@namitad namitad left a 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

@Madhura-saw
Copy link
Contributor Author

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

@namitad
Copy link
Collaborator

namitad commented Oct 1, 2023

@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?

@Madhura-saw
Copy link
Contributor Author

@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

@Madhura-saw
Copy link
Contributor Author

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.

Copy link
Collaborator

@namitad namitad left a comment

Choose a reason for hiding this comment

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

LGTM

@namitad
Copy link
Collaborator

namitad commented Oct 1, 2023

@Madhura-saw Thank you for your first contribution to Trapheus! I have added the required hacktoberfest labels as well.
Looking forward to more contributions!

@namitad namitad merged commit 4e5d657 into intuit:master Oct 1, 2023
2 checks passed
@Madhura-saw
Copy link
Contributor Author

@Madhura-saw Thank you for your first contribution to Trapheus! I have added the required hacktoberfest labels as well. Looking forward to more contributions!

Thank you :)

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

Successfully merging this pull request may close these issues.

None yet

2 participants