Skip to content
This repository has been archived by the owner on Apr 11, 2024. It is now read-only.

Latest commit

 

History

History
61 lines (38 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

61 lines (38 loc) · 2.6 KB
Raw

Contributing to nakamotojs-lib

We are always accepting of pull requests, but we do adhere to specific standards in regards to coding style, test driven development and commit messages.

Communication Channels

GitHub is the preferred method of communication between members.

Otherwise, in order of preference:

Workflow

The codebase is maintained using the "contributor workflow" where everyone without exception contributes patch proposals using "pull requests". This facilitates social contribution, easy testing and peer review.

To contribute a patch, the workflow is as follows:

  1. Fork repository
  2. Create topic branch
  3. Commit patches
  4. Push changes to your fork
  5. Submit a pull request to https://github.com/bitcoin-computer/nakamotojs-lib/pulls

Commits should be atomic and diffs easy to read.

If your pull request is accepted for merging, you may be asked by a maintainer to squash and or rebase your commits before it is merged.

Please refrain from creating several pull requests for the same change.

Patches should be focused:

* Adding a feature, or
* Fixing a bug, or
* Refactoring code.

If you combine these, the PR may be rejected or asked to be split up.

The length of time required for peer review is unpredictable and will vary from pull request to pull request.

Refer to the Git manual for any information about git.

Regarding TypeScript

This library is written in TypeScript with eslint, prettier, and the tsc transpiler. These tools will help during testing to notice improper logic before committing and sending a pull request.

Some rules regarding TypeScript:

  • Modify the typescript source code in an IDE that will give you warnings for transpile/lint errors.
  • Once you are done with the modifications, run npm run format then npm test
  • Running the tests will transpile the ts files into js and d.ts files.
  • Use git diff or other tools to verify that the ts and js are changing the same parts.
  • Commit all changes to ts, js, and d.ts files.
  • Add tests where necessary.
  • Submit your pull request.

Using TypeScript is for preventing bugs while writing code, as well as automatically generating type definitions. However, the JS file diffs must be verified, and any unverified JS will not be published to npm.