Skip to content

Latest commit

 

History

History
21 lines (14 loc) · 1.14 KB

Contributing.md

File metadata and controls

21 lines (14 loc) · 1.14 KB

Contributing

Oh, you want to help? Thank you so much! Seriously, that's wonderful.

Tips:

  1. Tests are encouraged. I mostly do end-to-end stuff using actual orgs. Check out the test helpers for some of that. a. if you're using the local FS as part of your test, be sure that it gets a unique name (I use the test's name) so that tests aren't colliding when run in parallel. You should clean up those changes at the end of your test.
  2. There's some commonly used libraries in here (fs-extra, request-promise-native). Try to use the stuff in jsforce when you can, then existing libs, then new dependencies.
  3. There's some helpers also for converting between xml and json stuff...helpful for local metadata edits
  4. Look around the existing commands a bit and try to match styles so it's easier for other users to make sense of all this. Examples a. return some object for --json users b. use the oclif/sfdx flags types and options

Testing

you can run a single file with yarn test test/commands/shane/whatever.test.ts

Packaging/Versions

Just PR your code changes. I'll handle the version/publishing process after merging your changes in