Skip to content

Latest commit

 

History

History
39 lines (23 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

39 lines (23 loc) · 1.51 KB
Raw

Contributing to veggies

Find veggies useful and want to get involved? Thanks! There are plenty of ways you can help.

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.

Setting Up a Local Copy

  1. Clone the repo with git clone https://github.com/ekino/veggies

  2. Run yarn install in the root veggies folder.

Once it is done, you can modify any file locally and run yarn run examples start or yarn test to check it.

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 veggies. 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.

Updating README.md

README.md is meant to be generated from doc/README.tpl.md and the various Gherkin definitions in this project.

You should never update it directly, and should instead :

  1. Edit doc/README.tpl.md

  2. Run yarn readme to generate README.md