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

Latest commit

 

History

History
53 lines (32 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

53 lines (32 loc) · 2.01 KB
Raw

Contributing

How to contribute to the AfterShip SDK for Node.js

There are many ways that you can contribute to the AfterShip SDK project:

  • Submit a bug
  • Submit a code fix for a bug
  • Submit additions or modifications to the documentation
  • Submit a feature request

All code submissions will be reviewed and tested by the team, and those that meet a high bar for both quality and design/roadmap appropriateness will be merged into the source. Be sure to follow the existing structure when adding new files/folders.

All code should follow ESLint with Airbnb style and error-free when run through npm run lint.

If you encounter any bugs with the library please file an issue in the Issues section of the project.

Things to keep in mind when contributing

Some guidance for when you make a contribution:

  • Add/update unit tests and code as required by your change
  • Make sure you run all the unit tests before you create a Pull Request.
  • Run end-to-end tests or simple sample code to make sure the lib works in an end-to-end scenario.

Big contributions

If your contribution is significantly big it is better to first check with the project developers in order to make sure the change aligns with the long term plans. This can be done simply by submitting a question via the GitHub Issues section.

Setting up your environment

Want to get started hacking on the code? Super! Follow these instructions to get up and running.

First, make sure you have the prerequisites installed and available on your $PATH:

  • Git
  • Node 10.x or higher
  • Yarn

Next, get the code:

  1. Fork this repo
  2. Clone your fork locally (git clone https://github.com/<youruser>/aftership-sdk-nodejs.git)
  3. Open a terminal and move into your local copy (cd aftership-sdk-nodejs)
  4. Install and link all dependencies (yarn)

Building

Run npm run build

Testing

Run npm run test