Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contribution guidelines could be more clear #431

Closed
jvoytek opened this issue Aug 28, 2023 · 2 comments
Closed

Contribution guidelines could be more clear #431

jvoytek opened this issue Aug 28, 2023 · 2 comments

Comments

@jvoytek
Copy link
Collaborator

jvoytek commented Aug 28, 2023

  • update text to use more direct language
  • update instruction for yarn *:check (yarn check seems to be more correct)
  • use shorter sentences where possible
@jvoytek
Copy link
Collaborator Author

jvoytek commented Aug 28, 2023

@hammer Specific Changes:

Contributing

Before making a change please discuss the change you wish to make with the owners of this repository. Discuss changes via issue issue or any other method.

Our code style

There is an eslint, prettier and python config that ensures a consistent code style. We also recommend 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.

Branching guidelines

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.

Pull Request Process

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!


cguedes pushed a commit that referenced this issue Aug 29, 2023
make contribution guidelines more clear (#431)
@hammer
Copy link
Contributor

hammer commented Aug 30, 2023

Closed by #433

@hammer hammer closed this as completed Aug 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants