Before making a change please discuss the change you wish to make with the owners of this repository. Dicuss changes via issue issue or any other method.
There is an eslint, prettier and python config that ensures a consistent code style. We also reccomend auto-save and format on save configured for VS Code. To check for style errors, run $ yarn check
. Code style will also be checked when you push using a git hook. Make sure it’s passing before sending a pull request.
We don't have a strict rule for branch name guidelines. You should try to name your branch using kebab-case with the name of the feature/issue your are working on (eg: adopt-jotai
). You can also prefix your branch name with the issue number if you are creating the branch from issues in GitHub.
Please try to keep your pull request focused, in scope, and avoid including unrelated commits.
We adopted the Squash and merge convention to give a nice, clean, linear history on main
which makes it easier to bisect and track changes.
Thank you for contributing!