Skip to content

Latest commit

 

History

History
39 lines (21 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

39 lines (21 loc) · 2.39 KB

Contributing to fulfillmenttools commercetools Connect app

Thank you for your interest in contributing to fulfillmenttools commercetools Connect app!

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

Reporting New Issues

We use GitHub issues for our public bugs. If you would like to report a problem, take a look around and see if someone already opened an issue about it. If you are certain this is a new unreported bug, you can submit a bug report.

Submitting a Pull Request

Good pull requests, such as patches, improvements, and new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first if somebody else is already working on this or the core developers think your feature is in-scope for the related package / project. Generally always have a related issue with discussions for whatever you are including.

Please also provide a test plan, i.e. specify how you verified that your addition works.

Please adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).

Setting Up a Local Copy

  1. Clone the repo with git clone git@github.com:fulfillmenttools/commercetools-connector.git
  2. Run nvm use and npm install
  3. Use npm run build, npm run test, and npm run lint to make sure your modifications can be compiled and all tests are green.

Coding Conventions

We use ESLint, Prettier, and EditorConfig for consistent coding style and formatting.

Questions

Feel free to reach out to us at opensource@fulfillmenttools.com if you have questions about our process, how to proceed, etc.

License

By contributing to the fulfillmenttools commercetools Connect app, you agree that your contributions will be licensed under its MIT license.