CONTRIBUTING.md

⊱⋅──────⋅⊱ Contributing to isomorphic-git ⊰⋅──────⋅⊰

Oh wow! Thanks for opening up the contributing file! 😁 🎉

You are very welcome here and any contribution is appreciated. 👍

New feature checklists ✨️

I'm honestly documenting these steps just so I don't forget them myself.

To add an argument to an existing command:

• add parameter to the function in src/commands/X.js
• add parameter to docs/X.md
• add parameter to the TypeScript library definition for X in src/index.d.ts
• add a test case in __tests__/test-X.js if possible
• make a feature commit "feat: Added new 'bar' argument to X"

To create a new command:

• add as a new file in src/commands
  • add command to src/commands.js
• add command to README list of commands
• add TypeScript definition in src/index.d.ts
• create a new doc page docs/X.md
  • add page to the Alphabetical Index
  • add page to the sidebar
• create a test in src/__tests__
• make a feature commit "feat: Added 'X' command"