search

ducminh-phan / reformat-gherkin

Formatter for Gherkin language
MIT License
22 stars 13 forks source link

Add a CONTRIBUTING file #36

Closed rayjolt closed 4 years ago

rayjolt commented 4 years ago

It would be good to add a CONTRIBUTING file for other people who are interested in contributing the project. This would help people avoid my mistake of basing my first pull request against master instead of against develop. :)

It would also be good to separate the installation instructions for users from the installation instructions for developers. Having the installation instructions for users in the README, and installation instructions for developers in CONTRIBUTING, would make it easier for users to understand how to use the software.

ducminh-phan commented 4 years ago

Thank you for your suggestion. I'm also thinking of setting up a Homebrew formula. Do you think it's necessary, or installing with pip or pre-commit is good enough?

rayjolt commented 4 years ago

I don't have a Mac, so Homebrew isn't important for me. I think starting with just pip and pre-commit is good enough - we can always add other methods later.