Skip to content

Latest commit

 

History

History
64 lines (48 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

64 lines (48 loc) · 2.51 KB
Raw

Thanks for taking an interest in improving easy-git-annex. Here are some suggestions to help you get started.

Code

  1. Start your work on a new branch.
  2. The linter, npm run lint, is your friend.
  3. When you're done, submit a pull request.
  4. I'll work with you to prepare for release.

Tests

  1. Update the tests as necessary.
  2. The script npm run test runs all tests.
  3. The script npm run test:noanx skips the git-annex tests.
  4. To view test coverage, use the command npm run test:coverage.

Documentation

  1. To regenerate the documentation, use the command npm run typedoc.

How to add a command

  1. Add an empty entry for the foo command in the appropriate src/helpers/command-options.ts map.
  2. If the foo command has options, add interface FooOptions stub in src/interfaces/FooOptions.ts and export the interface in src/index.ts.
  3. Add the foo method to src/interfaces/git-annex-api.ts.
  4. Create the necessary stub test file(s) under tests/commands-*.
  5. Implement the foo method in src/git-annex-accessor.ts.
  6. One at a time, add any command options to FooOptions.ts, command-options.ts, and foo.test.ts (in the ApiOptions.noOp list).
  7. Write tests to demonstrate the other parameters are correctly connected to the actual foo command.
  8. Add a link and description line to the Documentation section of README.md.

Testing easy-git-annex changes in your application

  1. Yalc may be installed globally to test your easy-git-annex changes in your application.
  2. After building easy-git-annex with the npm run build command, use the command npm run yalc to push the build.
  3. Run yalc add easy-git-annex in your dependent project.
  4. Rebuild your application and test normally.

How to release a version

  1. Create a build VM on GitHub by creating a codespace using the dev container defined in the repository.
    • sets up a clean build environment
  2. Update the version number and release date in CHANGELOG.md and commit the file.
  3. $ npm version major|minor|patch
    • runs package script preversion
    • bumps package version per the version command parameter
    • runs package script version
    • git commit and tag
    • runs package script postversion
  4. $ npm login
  5. $ npm publish
  6. Shut down and delete the codespace.

License

The easy-git-annex package uses the MIT license in LICENSE.md. Your contribution is included as described by the Contributor License Agreement in CLA.md.

Help

You may contact me by e-mail, if desired. Please use the address in package.json.