Updates the README, adds a PR template #350
Merged
Conversation
This file contains 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
EdwinGuzman
reviewed
Jul 2, 2021
CHANGELOG.md
Outdated
| #### (Prerelease) Updated | ||
|
|
||
| - Updated the README. | ||
| - Added a Github template. |
There was a problem hiding this comment.
Can you add "pull request" before "template"?
EdwinGuzman
reviewed
Jul 2, 2021
README.md
Outdated
|
|
||
| #### Use npm version | ||
| #### Use NPM Version |
There was a problem hiding this comment.
npm uses all lowercase for its name so let's stick with all lowercase for npm.
EdwinGuzman
reviewed
Jul 2, 2021
README.md
Outdated
| To publish a new version, you need to create an npm account and be a collaborator on the package. Then you can run `npm publish` from your local copy of the repository. | ||
| If you're not already logged in to npm from your terminal, you'll have to do so at this point. Run `npm login` and enter your credentials when prompted. | ||
|
|
||
| Then, you can run `npm publish` from your local copy of the repository. |
There was a problem hiding this comment.
Can you add a reminder about being on the main branch before running npm publish?
EdwinGuzman
reviewed
Jul 2, 2021
EdwinGuzman
approved these changes
Jul 2, 2021
2 tasks
tdilauro
added a commit
to ThePalaceProject/circulation-admin
that referenced
this pull request
Jul 19, 2021
Sync up with [Simplified circulation-web](https://github.com/NYPL-Simplified/circulation-web) v0.5.1+ ([PR #350](NYPL-Simplified/circulation-web#350) / [commit 6f88c82](NYPL-Simplified/circulation-web@6f88c82)). Sync'd commits contain: - Some security fixes. - More systemic fix for the footer layout issue. - "[C]ustom Mocha reporter so that a formatted list of suites and tests can be generated via the CLI." - Clarifications in README.md. I also had to make a few changes extra changes: - Address restrictions imposed by the `npx lint-staged` check that runs as a pre-commit hook. - Dropped our PR template and accepted the upstream one to make future syncs easier. They are identical and result in identical behavior. They were just in different places.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Updates the README to include more granularity in set up instructions and publishing instructions.
Adds a PR template (same as the one for the circulation repo).
Updates .travis.yml to reference the main branch instead of the master (will be changing the name overall now).