Best Practices #1474
Best Practices #1474
Conversation
- Includes a simple PR template
|
Looks good! Maybe one change is to change "Follow the pull request template..." to "Follow this pull request template... :" just for even more clarity that that is the template, and it's not located somewhere else? |
As long as we end up keeping the |
BEST-PRACTICES.md
Outdated
| - SUSHI uses [Prettier](https://prettier.io/) for code formating. | ||
| - To run the prettier on all code, run `npm run prettier`. Ensure there are no issues reported. | ||
| - Ensure any new dependencies do not contain any known security vulnerabilities | ||
| - To check for known security vulnerabilities, we recommend using [npm-audit](https://fshschool.org/). Run `npm audit` and ensure there are no new issues on your branch. |
There was a problem hiding this comment.
This probably isn't supposed to link to FSH School.
There was a problem hiding this comment.
Oh wow, you're very right! Thanks for catching that!
Fixed in d140715.
- Add info for test coverage command - Add info for prettier and lint fix commands - Add info about ensuring new dependencies are up to date - Require use of squash and merge
|
@mint-thompson and @cmoesel -- thanks for the feedback! I believe everything mentioned so far has been addressed. |
- Recommend use of Zulip for discussion - Note that if the conversation concludes that changes to the tooling are required, a GitHub issues should be created
Description: This PR documents best practices that development for SUSHI should follow. It also adds a basic PR template to encourage detailed PR descriptions. I used it here just to give you a feel for what it would look like. If we don't like the PR template, I can tweak it or remove it.
Testing Instructions: Review the new Best Practices document and the PR template, and let me know if there are any best practices you like that I haven't included or if I've been too strict in any areas.
Related Issue: N/A