@@ -13,14 +13,32 @@ our team in determining a solution for the issue.
1313
1414## Raising a Pull Request
1515
16- After your changes are ready for review, raise a PR with your branch against master !
16+ After your changes are ready for review, raise a PR with your branch against ` main ` !
1717
1818> ℹ️ If you are releasing a patch for a version, please branch off
1919> of the appropriate stable release branch or tag. When your PR is ready for review,
2020> raise the PR against the stable release branch. If one doesn't exist, ask the
2121> maintainers to create one.
2222
23+ Our current way of working with PRs involves committing and reviewing changes internally
24+ in a private repository and then syncing said changes to the public repository (with
25+ a mention the the original author of course).
26+
27+ To speed up the process (or just notify us in case we may have missed it) send us an email at
28+ thirdpartysupport@klaviyo.com , we'll make sure to take a look.
29+
2330## Local Environment
2431
2532Check the [ plugin development and customization documentation] ( ./plugin-development-customization.md ) for all the
2633details on how to install and test the plugin on your local environment.
34+
35+ ## Code recommendations
36+
37+ Ideally, code contributions should:
38+
39+ - Use descriptive names for variables and functions, to communicate intent.
40+ - Use ` prettier ` and ` yarn run lint ` (or ` yarn run lint:fix ` ) to help
41+ your code look clean and organized.
42+ - Have _ some_ test coverage, if appropriate. We try to stay above 80% coverage.
43+ - If considerably changing or introducing some behavior/feature, optionally add
44+ some documentation (or provide a summary in your PR, so we can write some instead).
0 commit comments