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

#65 - Reorganise code files in mdm-resources #67

Merged
merged 17 commits into from
Jun 23, 2022
Merged

Conversation

pjmonks
Copy link
Contributor

@pjmonks pjmonks commented Jun 22, 2022

Resolves #65

Re-organises all the files in the mdm-resources repo so that the layout more closely matches that in the Postman API documentation - though there may be some slight differences.

Everything still works in mdm-ui since the main entry point - src/index.ts - has been updated to export all types correctly, and mdm-ui references everything via the entry point.

Also updated some of the npm commands:

  • clean is only required now due to including the shx package - no longer need separate clear commands for Unix and Windows OSes
  • build commands are defined by their emitted outputs - es5, es6 an es2015
  • pr-checks added to run before submitting a PR in GitHub, ensuring the tasks pass before Jenkins runs them

@aaronforshaw aaronforshaw self-assigned this Jun 23, 2022
aaronforshaw
aaronforshaw previously approved these changes Jun 23, 2022
Copy link
Contributor

@aaronforshaw aaronforshaw left a comment

Choose a reason for hiding this comment

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

The new organisation is much easier to navigate and reflects the structure of the postman collection, which is great.

You could maybe update the README file with instructions on running pr-checks.

* Include much more detail
* Explain new npm commands available
@pjmonks
Copy link
Contributor Author

pjmonks commented Jun 23, 2022

@aaronforshaw I've updated the README as recommended, and filled in a lot more detail for it as a result.

Copy link
Contributor

@aaronforshaw aaronforshaw left a comment

Choose a reason for hiding this comment

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

Nice 👍

@pjmonks pjmonks merged commit 26b6195 into develop Jun 23, 2022
@pjmonks pjmonks deleted the feature/gh-65 branch June 23, 2022 11:19
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.

Re-organisation of code files
2 participants