Devex 1028 contribution guide

[jamesobrooks]

DevEx Issue 1028

Add detail to contribution guide

Additional Information

• Bugs/Issue reporting
• PR procedures
• Prerequisites

Inspiration

This is generally modeled after the React contribution guide.

Questions

Did I cover all tests that people not involved with Flexion or the Court can run? Are there more prerequisites and should we get more specific about the Node version? Can we ensure that outside contributions have had pre-commit hooks run?

[rosiehsmith]

For this question:

Can we ensure that outside contributions have had pre-commit hooks run?

I believe the closest we can request is that npm install when they start contributing (which I think you covered) because then husky will be installed on the postinstall step, so their next commit should run the pre-commit file from husky

[jamesobrooks]

For this question:

Can we ensure that outside contributions have had pre-commit hooks run?

I believe the closest we can request is that npm install when they start contributing (which I think you covered) because then husky will be installed on the postinstall step, so their next commit should run the pre-commit file from husky

That's kind of my concern. I don't know a way to trigger the hooks if there was a commit with the --no-verify flag. Certainly we could do things like copy the code in the changed files, apply it to a clean branch and run a commit without the flag just to see. But I doubt we want to put time into scripting something like that unless for some reason we start getting lots of contributions from outside the team.