Contributing document

[pcanella]

For a good open source project (public or internal), it would be nice to have a guideline on how to contribute to this project. Things should be cover on the document:

• [x] System requirements
• [x] Branching strategy
• [x] PR requirements:
  • Unit tests
  • Storybook
  • Update component readme
  • TypeScript type definitions
  • Pass the build (lint, unit test, ...)
• [x] Defintion of Done:
  • Comply to DS6, Skin, Playbook
  • Code review
• [x] Release process:
  • Versioning
  • Breaking changes
  • Steps to release
  • Update Storybook

For start, we can have similar contributing guideline as the one from eBay UI Core Marko (https://github.com/eBay/ebayui-core/blob/master/CONTRIBUTING.md)

[abiyasa]

Thanks for the details. This is related to issue #12 , could be the next phase after we split contribution guideline section from README

[abiyasa]

Things we can add to contribution document:

• PR guideline, not just how to submit or document format, but also the intent or scope of the PR. Quoted from our Slack chat:

  The PR it’s to add the page notice feature, not to upgrade the testing library. PR should be small and responsible for one thing only (unless is strictly necessary)